Stop a running instance of a job.
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v1/op/jobService/cancelrunning
Request Payload Parameters
runId
Long[]
|
The id of a job run instance on which the operation will be performed
|
Response Parameters
failure
OperationResultStatus[]
|
A list of job ids that fail in the operation
|
id
long
|
A job id or a run instance id
|
message
String
|
A system generated message
|
status
String
|
The result of an operation. Could be Success of Failure
|
|
message
String
|
A system generated message
|
operation
OperationEnum
|
The service name
Allowed values:
SUSPEND
RESUME
CANCEL
CANCELRUNNING
|
success
OperationResultStatus[]
|
A list of job ids that succeed in the operation
|
id
long
|
A job id or a run instance id
|
message
String
|
A system generated message
|
status
String
|
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://localhost/webacs/api/v1/op/jobService/cancelrunning
<?xml version="1.0" ?>
<jobRunOperationPayload>
<runIds>
<runId>15</runId>
</runIds>
</jobRunOperationPayload>
Sample JSON Request Payload
https://localhost/webacs/api/v1/op/jobService/cancelrunning.json
{
"jobRunOperationPayload" : {
"runIds" : {
"runId" : 15
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v1/op/jobService/cancelrunning
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/jobService/cancelrunning" rootUrl="https://localhost/webacs/api/v1/op">
<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://localhost/webacs/api/v1/op/jobService/cancelrunning.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/jobService\/cancelrunning",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"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"
}
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v2/op/jobService/cancelrunning
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
runId
Long[]
|
The id of a job run instance on which the operation will be performed
|
Response Parameters
failure
OperationResultStatus[]
|
A list of job ids that fail in the operation
|
id
long
|
A job id or a run instance id
|
message
String
|
A system generated message
|
status
String
|
The result of an operation. Could be Success of Failure
|
|
message
String
|
A system generated message
|
operation
OperationEnum
|
The service name
Allowed values:
SUSPEND
RESUME
CANCEL
CANCELRUNNING
|
success
OperationResultStatus[]
|
A list of job ids that succeed in the operation
|
id
long
|
A job id or a run instance id
|
message
String
|
A system generated message
|
status
String
|
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://localhost/webacs/api/v2/op/jobService/cancelrunning
<?xml version="1.0" ?>
<jobRunOperationPayload>
<runIds>
<runId>15</runId>
</runIds>
</jobRunOperationPayload>
Sample JSON Request Payload
https://localhost/webacs/api/v2/op/jobService/cancelrunning.json
{
"jobRunOperationPayload" : {
"runIds" : {
"runId" : [ 15 ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v2/op/jobService/cancelrunning
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/jobService/cancelrunning" rootUrl="https://localhost/webacs/api/v2/op">
<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://localhost/webacs/api/v2/op/jobService/cancelrunning.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/jobService/cancelrunning",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"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"
} ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v3/op/jobService/cancelrunning
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
runId
Long[]
|
The id of a job run instance on which the operation will be performed
|
Response Parameters
failure
OperationResultStatus[]
|
A list of job ids that fail in the operation
|
id
long
|
A job id or a run instance id
|
message
String
|
A system generated message
|
status
String
|
The result of an operation. Could be Success of Failure
|
|
message
String
|
A system generated message
|
operation
OperationEnum
|
The service name
Allowed values:
SUSPEND
RESUME
CANCEL
CANCELRUNNING
|
success
OperationResultStatus[]
|
A list of job ids that succeed in the operation
|
id
long
|
A job id or a run instance id
|
message
String
|
A system generated message
|
status
String
|
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://localhost/webacs/api/v3/op/jobService/cancelrunning
<?xml version="1.0" ?>
<jobRunOperationPayload>
<runIds>
<runId>15</runId>
<runId>25</runId>
</runIds>
</jobRunOperationPayload>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/jobService/cancelrunning.json
{
"jobRunOperationPayload" : {
"runIds" : {
"runId" : [ 15, 25 ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v3/op/jobService/cancelrunning
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/jobService/cancelrunning" rootUrl="https://localhost/webacs/api/v3/op">
<operationResult>
<failure>
<failure>
<id>2</id>
<message>String value</message>
<status>String value</status>
</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>
<id>2</id>
<message>String value</message>
<status>String value</status>
</success>
</success>
</operationResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/jobService/cancelrunning.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/jobService/cancelrunning",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"operationResult" : [ {
"failure" : {
"failure" : [ {
"id" : 2,
"message" : "String value",
"status" : "String value"
}, {
"id" : 2,
"message" : "String value",
"status" : "String value"
} ]
},
"message" : "String value",
"operation" : "SUSPEND",
"success" : {
"success" : [ {
"id" : 2,
"message" : "String value",
"status" : "String value"
}, {
"id" : 2,
"message" : "String value",
"status" : "String value"
} ]
}
} ]
}
}