Disable the trigger permanently. The canceled job cannnot be resumed using "Resume A Job" service
Resource URL
/webacs/api/v1/op/jobService/cancel
Since : 2.2
Request Payload Parameters
Long[]
|
jobId
|
The id of a job on which the operation will be performed
|
Response Parameters
OperationResultStatus[]
|
failure
|
A list of job ids that fail in the operation
|
long
|
id
|
A job id or a run instance id
|
String
|
message
|
A system generated message
|
String
|
status
|
The result of an operation. Could be Success of Failure
|
|
String
|
message
|
A system generated message
|
OperationEnum
|
operation
|
The service name
Allowed values:
SUSPEND
RESUME
CANCEL
CANCELRUNNING
|
OperationResultStatus[]
|
success
|
A list of job ids that succeed in the operation
|
long
|
id
|
A job id or a run instance id
|
String
|
message
|
A system generated message
|
String
|
status
|
The result of an operation. Could be Success of Failure
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Request Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/jobService/cancel
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobOperationPayload>
<jobIds>
<jobId>15</jobId>
</jobIds>
</jobOperationPayload>
Sample JSON Request Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/jobService/cancel.json
{
"jobOperationPayload" : {
"jobIds" : {
"jobId" : 15
}
}
}
Sample XML Response Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/jobService/cancel
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/" requestUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/jobService/cancel" responseType="operation">
<operationResult>
<failure>
<failure>
<id>2</id>
<message>String value</message>
<status>String value</status>
</failure>
</failure>
<message>String value</message>
<operation>SUSPEND</operation>
<success>
<success>
<id>2</id>
<message>String value</message>
<status>String value</status>
</success>
</success>
</operationResult>
</mgmtResponse>
Sample JSON Response Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/jobService/cancel.json
{
"mgmtResponse" : {
"@rootUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/",
"@requestUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/jobService\/cancel",
"@responseType" : "operation",
"operationResult" : {
"failure" : {
"failure" : {
"id" : 2,
"message" : "String value",
"status" : "String value"
}
},
"message" : "String value",
"operation" : "SUSPEND",
"success" : {
"success" : {
"id" : 2,
"message" : "String value",
"status" : "String value"
}
}
}
}
}