9,310
edits
Resco CRM Connector: Difference between revisions
Jump to navigation
Jump to search
→POST GenerateReport
| Line 634: | Line 634: | ||
<GenerateReportFormat>Excel</GenerateReportFormat> | <GenerateReportFormat>Excel</GenerateReportFormat> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== POST ExecuteWorkflow === | |||
Allows you to start a [[Server processes|server process workflow]]. | |||
<syntaxhighlight lang="xml"> | |||
<WorkflowExecuteRequest> | |||
<WorkflowReference>resco_workflow:C0A79A17-FDDD-4152-9B19-F24FAF7D8095</WorkflowReference> | |||
<PrimaryEntity> | |||
<name>Entity name</name> | |||
<country>XX</country> | |||
</PrimaryEntity> | |||
<PrimaryReference>account:56de02f2-732a-4020-837e-93561c70ad07</PrimaryReference> | |||
<InputVariables> | |||
<Variable Name="Test1" Type="Integer" Value="50" /> | |||
<Variable Name="Test2" Type="String" Value="string" /> | |||
<Variable Name="Test3" Type="Float" Value="45.26" /> | |||
<Variable Name="Test4" Type="DateTme" Value="2021-18-01T16:09:53Z" /> | |||
<Variable Name="Test5" Type="Decimal" Value="65.26" /> | |||
<Variable Name="Test6" Type="BigInt" Value="156" /> | |||
<Variable Name="Test7" Type="Lookup" Value="contact:826191dc-2dea-47f7-9b38-616b22129d8b" /> | |||
</InputVariables> | |||
<OutputVariables> | |||
<Variable>Var1</Variable> | |||
<Variable>Var2</Variable> | |||
</OutputVariables> | |||
</WorkflowExecuteRequest> | |||
</syntaxhighlight> | |||
* WorkflowReference - EntityReference to record in resco_workflow entity. | |||
* PrimaryEntity - Determine the primary entity used in the workflow as the 'Entity' variable. It can be defined as a new Entity. | |||
* PrimaryReference - Determine the primary entity used in the workflow as the 'Entity' variable. It can be defined as an EntityReference to an existing entity record. | |||
* InputVariables - Determine input variables that can be used in the workflow. | |||
* OutputVariables - Determine names of variables that should be returned from the workflow. | |||
<syntaxhighlight lang="xml"> | |||
<WorkflowExecuteResult> | |||
<Result>Succeeded</Result> | |||
<Saved>true</Saved> | |||
<Log>Workflow log.</Log> | |||
<OutputVariables> | |||
<Variable Name="Var1" Type="Integer" Value="100" /> | |||
<Variable Name="Var2" Type="String" Value="string + output" /> | |||
</OutputVariables> | |||
</WorkflowExecuteResult> | |||
</syntaxhighlight> | |||
* Result - Determine the result status of the workflow (InProgress, Succeeded, Failed, Canceled). | |||
* Saved - Determine whether the WorkflowExecuteRequest.PrimaryEntity was changed and updated after workflow execution. | |||
* Log - Determine the result log printed by workflow. | |||
* OutputVariables - Contains the output variables returned from the workflow. | |||
== Webhooks == | == Webhooks == | ||