Default Plugins
Cancellation Manager
Async API for cancelling a job based on its workOrder
1min
POST
HEADER PARAMETERS
X-COREOS-REQUEST-ID
string
Unique RequestId
X-AUTH
string
*HMAC hash
BODY PARAMETERS
body
CancellationManagerRequestDetails
*Job Cancellation manager request details
tenantId
string
*tenant ID
orderState
string
*state of the order
orderSubState
string
*subState of the order
orderId
string
*order id
workorderId
string
workorder id
jobId
string
*job id of the job that has to be cancelled
jobState
string
*state of the job
jobSubState
string
*subState of the job
callback
CallbackMeta
*details of callback URL in case of async plugin
RESPONSES
202
ACCEPTED
SyncSuccessResponse
error
Error
*Error information
request
Request
*data
object
Example: [object Object]
400
Error Occurred
PostErrorResponse
error
Error
*Error information
request
Request
*401
Error Occurred
PostErrorResponse
error
Error
*Error information
request
Request
*

Updated 03 Aug 2023
Did this page help you?