Create a new job

1min
POST
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
*
X-COREOS-CALLBACK-SECRET
string
Body Parameters
body
JobRequest
*
Description
Job request.
jobWorkflowId
JobWorkflowId
*
jobRef
JobRef
objectives
ObjectiveRequest[]
*
containers
string[]
batchId
BatchId
jobTypeName
string
jobTypeId
string
*
_event_meta
Meta
scheduledFor
ScheduledFor
assets
Assets[]
orderId
orderId
workOrderId
workOrderId
onHold
boolean
onRequest
CustomCallRequestObject
onError
CustomCallErrorObject
callback
CallbackObject
Responses
202
OK
SuccessResponse
error
Error
*
request
Request
*
data
object
400
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
401
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/core/api/v2/dispatch-service/jobs' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "jobWorkflowId": "",
  "objectives": [
    {
      "objectiveRef": "",
      "location": {},
      "contact": {},
      "timeSlot": {
        "from": 0,
        "to": 0
      },
      "input": {}
    }
  ],
  "jobTypeId": "",
  "scheduledFor": {
    "startDateTime": 0
  },
  "assets": [
    {
      "documentType": "",
      "documentUrl": ""
    }
  ],
  "onRequest": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  },
  "onError": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  }
}'
curl --location --globoff 'https://{domain}/core/api/v2/dispatch-service/jobs' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "jobWorkflowId": "",
  "objectives": [
    {
      "objectiveRef": "",
      "location": {},
      "contact": {},
      "timeSlot": {
        "from": 0,
        "to": 0
      },
      "input": {}
    }
  ],
  "jobTypeId": "",
  "scheduledFor": {
    "startDateTime": 0
  },
  "assets": [
    {
      "documentType": "",
      "documentUrl": ""
    }
  ],
  "onRequest": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  },
  "onError": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  }
}'
Responses
202
400
401
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
﻿
﻿
Updated 03 Aug 2023
Did this page help you?
Update job workflow status
Update job by job ref