Dispatch Service
Job
Create a new job
1min
POST
HEADER PARAMETERS
X-COREOS-REQUEST-ID
string
*Unique RequestId
X-COREOS-TID
string
*Tenant id
X-COREOS-ACCESS
string
*Access Token
X-COREOS-USERINFO
string
*user info
X-COREOS-CALLBACK-SECRET
string
callback secret (base64 encoded string)
BODY PARAMETERS
body
JobRequest
*Job request.
jobWorkflowId
JobWorkflowId
*Job workflow ID
jobRef
JobRef
Job ref
objectives
ObjectiveRequest[]
*containers
string[]
Example:
List of containers
batchId
BatchId
Batch Id.
jobTypeName
string
Job Type Name
jobTypeId
string
*Job Type Id
_event_meta
Meta
Meta data
scheduledFor
ScheduledFor
Time slot scheduled for job
assets
Assets[]
Asset
orderId
orderId
Order Id
workOrderId
workOrderId
WO Id
onHold
boolean
Flag to specify if a job is on-hold
onRequest
CustomCallRequestObject
onError
CustomCallErrorObject
callback
CallbackObject
RESPONSES
202
OK
SuccessResponse
error
Error
*Error information
request
Request
*data
object
Example: [object Object]
400
Error Occurred
ErrorResponse
error
Error
*Error information
request
Request
*401
Error Occurred
ErrorResponse
error
Error
*Error information
request
Request
*

Updated 03 Aug 2023
Did this page help you?