Stop a running instance of a job.
Since Product Version: 2.2
Resource URL
/webacs/api/v1/op/jobService/cancelrunningRequest Payload Parameters
Type | Attribute Name | Description |
---|---|---|
Long[] |
runId |
The id of a job run instance on which the operation will be performed |
Response Parameters
Type | Attribute Name | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
failure |
A list of job ids that fail in the operation |
|||||||||||||
|
||||||||||||||
String |
message |
A system generated message |
||||||||||||
OperationEnum |
operation |
The service name Allowed values: |
||||||||||||
success |
A list of job ids that succeed in the operation |
|||||||||||||
|
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://192.168.115.187/webacs/api/v1/op/jobService/cancelrunning
XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <jobRunOperationPayload> <runIds> <runId>15</runId> </runIds> </jobRunOperationPayload>
Sample JSON Request Payload
https://192.168.115.187/webacs/api/v1/op/jobService/cancelrunning.json
{ "jobRunOperationPayload" : { "runIds" : { "runId" : 15 } } }
Sample XML Response Payload
https://192.168.115.187/webacs/api/v1/op/jobService/cancelrunning
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <mgmtResponse rootUrl="https://192.168.115.187/webacs/api/v1/op/" requestUrl="https://192.168.115.187/webacs/api/v1/op/jobService/cancelrunning" 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://192.168.115.187/webacs/api/v1/op/jobService/cancelrunning.json
{ "mgmtResponse" : { "@rootUrl" : "https : \/\/192.168.115.187\/webacs\/api\/v1\/op\/", "@requestUrl" : "https : \/\/192.168.115.187\/webacs\/api\/v1\/op\/jobService\/cancelrunning", "@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" } } } } }