How to: Manage Dispatch

for information about prerequisites, see integrate with dispatch docid 3jkkjjw3r0n1l32h lbgo create dispatch attributes to create dispatch attributes, call the post attribute config for dispatch docid\ rhli3gskwlnsjldhm5dhj endpoint and pass the following required members in the request body member description remarks attributes > name name of the attribute string minlength 1 maxlength 32 pattern ^\[a za z]{1,32}$ attributes > datatype data type of the attribute string enum \[string, number, boolean, object, array] attributes > validation > range > min & max field to specify the range that the attribute value must lie in the case of the "string" datatype, the range will be the length of a string value this validation allowed only for string and number type of attributes number 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 get attribute config of dispatch docid\ wmprb8fqo yrnjoq8mx p endpoint and specify the dispatchtypeid in the path parameter create a dispatch to create a dispatch, call the create a new dispatch docid 2u7nucsdzbx4tmu4h je0 endpoint and pass the following required members in the request body member description remarks dispatchtypeid id of the dispatch type string minlength 4 maxlength 64 dispatchref (optional) external dispatch reference string min length 4maxlength 64 dispatchtypename (optional) dispatch type name string minlength 4 maxlength 64 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 add job to a dispatch docid\ esp6ujpzqc0acgjamdtbu endpoint and pass the following required members in the request body member description remarks jobid id of the job string minlength 1 maxlength 64 callback > url callback url to check whether a job can be added to a dispatch string 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 add multiple jobs to a dispatch docid\ af1nztmo7zk4hihsulkqu endpoint and pass the following required members in the request body member description remarks jobs id of the jobs to be added to the dispatch string minlength 1 maxlength 64 callback > url callback url to check whether a job can be added to a dispatch string 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 add participant to a dispatch docid\ afzfig07kpfjlvuswew1q endpoint and pass the following required members in the request body here is the markdown table member description remarks participantid id of the participant string minlength 1 maxlength 64 callback > url callback url to check whether a participant can be added to a dispatch string 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 add multiple participants to a dispatch docid\ kd3ygjptaripgsrl1lpbj endpoint and pass the following required members in the request body here is the markdown table member description remarks participants id of the participants to be added to the dispatch string min length 1 maxlength 64 minitems 1 maxitems 10 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 change status and substatus of a dispatch docid\ fjk0wiwkfhi47ag2zbsu1 endpoint and pass the required members in the request body also, specify the dispatchid in the path parameter member description remarks status dispatch status string enum \[closed, pending closure, in progress] 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 change sub status of a dispatch docid 0v wo m pc2tmrbtbiysg endpoint and pass the following required members in the request body also, specify the dispatchid in the path parameter member description remarks substatus dispatch sub status string maxlength 64 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 remove a job from dispatch 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 remove multiple jobs from a dispatch docid\ nviu5tyjktbal3jdsaiku endpoint specify dispatchid in the path parameter pass the following required members in the request body member description remarks jobs job ids of the jobs to be removed string minitems 1 minlength 1 maxlength 64 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" {} }