OS1 Services
...
Dispatch Service
Integrate with Dispatch
How to: Manage Job Workflow
4min
for information about prerequisites, see integrate with dispatch docid 3jkkjjw3r0n1l32h lbgo create a job workflow to create a job workflow, call the create a new job workflow docid\ qquueposkyetzd8lgtfh6 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 { "name" “pickupjobworkflow”, "start" "pickup", "objectives" \[ { "objectiveref" "pickup", "workflow" "workflow 813d56f2 c9ce 5741 9536 895e6be5a88b", "next" \[ { "code" "a", "nextobjective" "end state" } ] } ] } retrieve job workflow by job workflow id to retrieve a job workflow call the get job workflow by job workflow id docid 2rn2et30hhwjuysnodcsx endpoint and specify the jobworkflowid in the path parameter update job workflow status to update the status of a job workflow, call the update job workflow status docid 9xpeplhaowh7ifof gbuo 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 { "status" "active" }