How to: Manage Dispatch

for information about prerequisites, see docid 3jkkjjw3r0n1l32h lbgo create dispatch attributes to create dispatch attributes, call the docid\ rhli3gskwlnsjldhm5dhj 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 dispatchtypeid in the path parameter the json request body should be similar to the following { "attributes" \[ { "name" "string", "description" "string", "tags" \[ "string" ], "datatype" "string", "indexed" false, "defaultvalue" {}, "validation" { "range" { "min" 0, "max" 0 }, "regex" "string", "valueoneof" \[ "string" ], "required" false } } ], " event meta" {} } retrieve attribute config of a dispatch to retrieve the attributes of a dispatch, call the docid\ wmprb8fqo yrnjoq8mx p endpoint and specify the dispatchtypeid in the path parameter create a dispatch to create a dispatch, call the docid 2u7nucsdzbx4tmu4h je0 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 the json request body should be similar to the following { "dispatchref" "string", "dispatchtypename" "string", "dispatchtypeid" "string", "jobs" \[ "string" ], "participants" \[ "string" ], "customdata" { "additionalprop1" {} }, " event meta" {}, "additionalprop1" {} } add job to a dispatch to add a job to a dispatch, call the docid\ esp6ujpzqc0acgjamdtbu 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 { "jobid" "string", "callback" { "url" "string", "headers" \[ { "key" "string", "value" "string" } ] }, " event meta" {} } to add multiple jobs to a dispatch, call the docid\ af1nztmo7zk4hihsulkqu 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 { "jobs" \[ "string" ], "callback" { "url" "string", "headers" \[ { "key" "string", "value" "string" } ] }, " event meta" {} } add participant to a dispatch to add a participant to a dispatch, call the docid\ afzfig07kpfjlvuswew1q endpoint and pass the following required members in the request body 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 the json request body should be similar to the following { "participantid" "string", "callback" { "url" "string", "headers" \[ { "key" "string", "value" "string" } ] }, " event meta" {} } to add multiple participants to a dispatch, call the docid\ kd3ygjptaripgsrl1lpbj endpoint and pass the following required members in the request body 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 the json request body should be similar to the following { "participants" \[ "string" ], " event meta" {} } update the status and sub status of a dispatch to update the status and sub status of a dispatch, call the docid\ fjk0wiwkfhi47ag2zbsu1 endpoint and pass the required members in the request body also, specify the dispatchid 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" "closed", "substatus" "string", " event meta" {} } to update the sub status of a dispatch, call the docid 0v wo m pc2tmrbtbiysg endpoint and pass the following required members in the request body also, specify the dispatchid 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" {} } remove job from a dispatch to remove a job from a dispatch, call the docid\ xdf8obfy6deosndythvg endpoint specify dispatchid and jobid in the path parameter the json request body should be similar to the following { " event meta" {} } to remove multiple jobs from a dispatch, call the docid\ nviu5tyjktbal3jdsaiku endpoint specify dispatchid in the path parameter 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 the json request body should be similar to the following { "jobs" \[ "string" ], " event meta" {} } remove participant from a dispatch to remove a participant from a dispatch, call the endpoint specify dispatchid and participantid in the path parameter the json request body should be similar to the following { " event meta" {} }