Update job by job ref

1min
PUT
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
JobUpdateByRef
*
Description
Update job by job ref
jobRef
JobRef
*
status
JobStatus
*
subStatus
SubStatus
_event_meta
Meta
orderId
orderId
onRequest
CustomCallRequestObject
onError
CustomCallErrorObject
callback
CallbackObject
Responses
200
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 --request PUT 'https://{domain}/core/api/v2/dispatch-service/jobs' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "jobRef": "",
  "status": "",
  "onRequest": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  },
  "onError": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  }
}'
curl --location --globoff --request PUT 'https://{domain}/core/api/v2/dispatch-service/jobs' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "jobRef": "",
  "status": "",
  "onRequest": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  },
  "onError": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  }
}'
Responses
200
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?
Create a new job
Get job by job id