How to: Manage Job Workflow
For information about prerequisites, see Integrate with Dispatch.
To create a Job Workflow, call the Create Job Workflow endpoint and pass the following required members in the request body:
Member | Description | Remarks |
|---|---|---|
name | Job Workflow name. | stringminLength= 1 and maxLength= 24 Pattern: ^[a-zA-Z0-9- _]{1,24}$. |
start | This is the starting objective reference. | stringminLength= 4 and maxLength= 36 |
objectives > objectiveRef | Reference IDs for individual objectives. | stringminLength= 4 and maxLength= 36 |
objectives > workflow | Workflow ID. | stringminLength= 1 and maxLength= 64 |
objectives > next > code | Event or Reason Code. | stringminLength= 4 and maxLength= 36 |
objectives > next > nextObjective | Reference ID for individual objectives or END for the last state. | stringminLength= 4 and maxLength= 36 |
The request body should be similar to the following:
To retrieve a Job Workflow call the Get Job Workflow endpoint and specify the jobWorkflowId in the path parameter.
To update the status of a Job Workflow, call the Update Job Workflow Status endpoint and pass the following member in the request body:
Member | Description | Remarks |
|---|---|---|
status | This is the Job Workflow status. | It can have one of the possible values: Active and Inactive. |
Also, specify the jobWorkflowId in the path parameter.
The JSON request body should be similar to the following: