Disable the trigger temporarily. The job will no longer run when suspended. To re-enable the job trigger, use 'Resume A Job' service. Suspending a job in running status dose not impact the running instance.
Since Product Version: 2.2
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/jobService/suspend
Request Payload Parameters
jobId
Long[]
|
Required
The
id of the job 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
|
|
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://172.20.127.108/webacs/api/v1/op/jobService/suspend
<?xml version="1.0" ?>
<jobOperationPayload>
<jobIds>
<jobId>15</jobId>
<jobId>25</jobId>
</jobIds>
</jobOperationPayload>
Sample JSON Request Payload
https://172.20.127.108/webacs/api/v1/op/jobService/suspend.json
{
"jobOperationPayload" : {
"jobIds" : {
"jobId" : [15,
25]
}
}
}
Sample XML Response Payload
https://172.20.127.108/webacs/api/v1/op/jobService/suspend
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v1/op">
<operationResult>
<failure>
<failure>
<id>2</id>
<message>String value</message>
<status>String value</status>
</failure>
<failure>
<id>12</id>
<message>Another string value</message>
<status>Another 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>12</id>
<message>Another string value</message>
<status>Another string value</status>
</success>
</success>
</operationResult>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v1/op/jobService/suspend.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op\/jobService\/suspend",
"@rootUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op",
"operationResult" : {
"failure" : {
"failure" : [{
"id" : 2,
"message" : "String value",
"status" : "String value"
},
{
"id" : 12,
"message" : "Another string value",
"status" : "Another string value"
}]
},
"message" : "String value",
"operation" : "SUSPEND",
"success" : {
"success" : [{
"id" : 2,
"message" : "String value",
"status" : "String value"
},
{
"id" : 12,
"message" : "Another string value",
"status" : "Another string value"
}]
}
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/jobService/suspend
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
jobId
Long[]
|
Required
The
id of the job 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
|
|
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://172.20.127.108/webacs/api/v2/op/jobService/suspend
<?xml version="1.0" ?>
<jobOperationPayload>
<jobIds>
<jobId>15</jobId>
<jobId>25</jobId>
</jobIds>
</jobOperationPayload>
Sample JSON Request Payload
https://172.20.127.108/webacs/api/v2/op/jobService/suspend.json
{
"jobOperationPayload" : {
"jobIds" : {
"jobId" : [ 15, 25 ]
}
}
}
Sample XML Response Payload
https://172.20.127.108/webacs/api/v2/op/jobService/suspend
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v2/op">
<operationResult>
<failure>
<failure>
<id>2</id>
<message>String value</message>
<status>String value</status>
</failure>
<failure>
<id>12</id>
<message>Another string value</message>
<status>Another 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>12</id>
<message>Another string value</message>
<status>Another string value</status>
</success>
</success>
</operationResult>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v2/op/jobService/suspend.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v2/op",
"operationResult" : [ {
"failure" : {
"failure" : [ {
"id" : 2,
"message" : "String value",
"status" : "String value"
}, {
"id" : 12,
"message" : "Another string value",
"status" : "Another string value"
} ]
},
"message" : "String value",
"operation" : "SUSPEND",
"success" : {
"success" : [ {
"id" : 2,
"message" : "String value",
"status" : "String value"
}, {
"id" : 12,
"message" : "Another string value",
"status" : "Another string value"
} ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/jobService/suspend
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
jobId
Long[]
|
Required
The
id of the job 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
|
|
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://172.20.127.108/webacs/api/v3/op/jobService/suspend
<?xml version="1.0" ?>
<jobOperationPayload>
<jobIds>
<jobId>15</jobId>
<jobId>25</jobId>
</jobIds>
</jobOperationPayload>
Sample JSON Request Payload
https://172.20.127.108/webacs/api/v3/op/jobService/suspend.json
{
"jobOperationPayload" : {
"jobIds" : {
"jobId" : [ 15, 25 ]
}
}
}
Sample XML Response Payload
https://172.20.127.108/webacs/api/v3/op/jobService/suspend
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v3/op">
<operationResult>
<failure>
<failure>
<id>2</id>
<message>String value</message>
<status>String value</status>
</failure>
<failure>
<id>12</id>
<message>Another string value</message>
<status>Another 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>12</id>
<message>Another string value</message>
<status>Another string value</status>
</success>
</success>
</operationResult>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v3/op/jobService/suspend.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v3/op",
"operationResult" : [ {
"failure" : {
"failure" : [ {
"id" : 2,
"message" : "String value",
"status" : "String value"
}, {
"id" : 12,
"message" : "Another string value",
"status" : "Another string value"
} ]
},
"message" : "String value",
"operation" : "SUSPEND",
"success" : {
"success" : [ {
"id" : 2,
"message" : "String value",
"status" : "String value"
}, {
"id" : 12,
"message" : "Another string value",
"status" : "Another string value"
} ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/jobService/suspend
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
jobId
Long[]
|
Required
The
id of the job 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
|
|
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://172.20.127.108/webacs/api/v4/op/jobService/suspend
<?xml version="1.0" ?>
<jobOperationPayload>
<jobIds>
<jobId>15</jobId>
<jobId>25</jobId>
</jobIds>
</jobOperationPayload>
Sample JSON Request Payload
https://172.20.127.108/webacs/api/v4/op/jobService/suspend.json
{
"jobOperationPayload" : {
"jobIds" : {
"jobId" : [ 15, 25 ]
}
}
}
Sample XML Response Payload
https://172.20.127.108/webacs/api/v4/op/jobService/suspend
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v4/op">
<operationResult>
<failure>
<failure>
<id>2</id>
<message>String value</message>
<status>String value</status>
</failure>
<failure>
<id>12</id>
<message>Another string value</message>
<status>Another 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>12</id>
<message>Another string value</message>
<status>Another string value</status>
</success>
</success>
</operationResult>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v4/op/jobService/suspend.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v4/op",
"operationResult" : [ {
"failure" : {
"failure" : [ {
"id" : 2,
"message" : "String value",
"status" : "String value"
}, {
"id" : 12,
"message" : "Another string value",
"status" : "Another string value"
} ]
},
"message" : "String value",
"operation" : "SUSPEND",
"success" : {
"success" : [ {
"id" : 2,
"message" : "String value",
"status" : "String value"
}, {
"id" : 12,
"message" : "Another string value",
"status" : "Another string value"
} ]
}
} ]
}
}