Async API for cancelling a job based on its workOrder

1min

POST
Header Parameters
X-COREOS-REQUEST-ID
string
X-AUTH
string
*
Body Parameters
body
CancellationManagerRequestDetails
*
Description
Job Cancellation manager request details
tenantId
string
*
orderState
string
*
orderSubState
string
*
orderId
string
*
workorderId
string
jobId
string
*
jobState
string
*
jobSubState
string
*
callback
CallbackMeta
*
Responses
202
ACCEPTED
SyncSuccessResponse
error
Error
*
request
Request
*
data
object
400
Error Occurred
PostErrorResponse
error
Error
*
request
Request
*
401
Error Occurred
PostErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/core/api/v1/cancellationManager/workOrderCancelled' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "tenantId": "",
  "orderState": "",
  "orderSubState": "",
  "orderId": "",
  "jobId": "",
  "jobState": "",
  "jobSubState": "",
  "callback": {
    "url": ""
  }
}'
curl --location --globoff 'https://{domain}/core/api/v1/cancellationManager/workOrderCancelled' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "tenantId": "",
  "orderState": "",
  "orderSubState": "",
  "orderId": "",
  "jobId": "",
  "jobState": "",
  "jobSubState": "",
  "callback": {
    "url": ""
  }
}'
Responses
202
400
401
// ACCEPTED 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "acknowledged": false
  }
}
// ACCEPTED 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "acknowledged": false
  }
}
﻿
﻿

Updated 03 Aug 2023

Did this page help you?

Plugin API for workflow manager

Async API for cancelling workOrder based on job