How to: Manage Jobs

11 min

for information about prerequisites, see docid 3jkkjjw3r0n1l32h lbgo create job attributes to create job attributes, call the docid\ wj8xio0jour7zt8u 0rdr endpoint and pass the following required members in the request body true left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type also, specify the jobtypeid in the path parameter the json request body should be similar to the following { "attributes" \[ { "name" "pickup", "description" "pickup job", "tags" \[ "pick" ], "datatype" "string", "indexed" false, "defaultvalue" {}, "validation" { "range" { "min" 0, "max" 0 }, "regex" "string", "valueoneof" \[ "string" ], "required" false } } ], " event meta" {} } retrieve job attributes to retrieve job attributes, call the docid 9ay 9fzfyydsgicwsloru endpoint and specify the jobtypeid in the path parameter create a job to create a job, call the docid\ z2ujp1bpq9p5dht2ojycd endpoint and pass the following required members in the request body true left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type the json request body should be similar to the following { "jobworkflowid" "pickupjobworkflow 11daaaf3 c0b3 4f17 b6ba 6e27d487aaa9", "jobref" "string", "objectives" \[ { "objectiveref" "pickup", "location" "location\ abce4567 e89b 12d3 a456 426614174000", "contact" "string", "timeslot" { "from" 1, "to" 1 }, "groupid" "string", "input" { "additionalprop1" {} } } ], "containers" \[ "string" ], "batchid" "string", "jobtypename" "string", "jobtypeid" "string", " event meta" {}, "scheduledfor" { "startdatetime" 0, "enddatetime" 0 }, "assets" \[ { "documenttype" "string", "description" "string", "documenturl" "string" } ], "orderid" "string", "workorderid" "string", "additionalprop1" {} } update a job to update a job, call the docid\ llw2pmc96 onbp4 vuixy endpoint and pass the following required members in the request body true left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type the json request body should be similar to the following { "jobref" "string", "status" "completed", "substatus" "string", " event meta" {}, "orderid" "string" } to update a job by job id, call the docid\ llw2pmc96 onbp4 vuixy endpoint and pass the following required members in the request body also, specify the jobid in the path parameter here is the markdown table true left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type the json request body should be similar to the following { "scheduledfor" { "startdatetime" 0, "enddatetime" 0 }, "assets" \[ { "documenttype" "string", "description" "string", "documenturl" "string" } ], "batchid" "string", "objectives" \[ { "objectiveref" "string", "contact" "string", "timeslot" { "from" 1, "to" 1 }, "groupid" "string" } ], "parentjobid" "string", "removeparentjob" true, " event meta" {} } retrieve existing jobs to retrieve the existing jobs, call the docid c5jkzirqk2vov8cdiohp endpoint and specify the jobid in the path parameter update the status and sub status of jobs to update the status and sub status of a job, call the docid\ xzvrsff7gmoqgovxbjixf endpoint and pass the required members in the request body also, specify the jobid in the path parameter true left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type the json request body should be similar to the following { "status" "completed", "substatus" "string", " event meta" {} } to update the sub status of a job, call the docid 6 7zzaukmdmla kc6v8rv endpoint and pass the required members in the request body also, specify the jobid in the path parameter true left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type the json request body should be similar to the following { "substatus" "string", " event meta" {} } to update the sub status of jobs, call the docid 6 7zzaukmdmla kc6v8rv endpoint and pass the required members in the request body true left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type the json request body should be similar to the following { "jobs" \[ { "jobid" "string", "substatus" "string" } ], " event meta" {} }