Activate/Suspend Job Definition By Id
Activates or suspends a given job definition by id.
Method
PUT /job-definition/{id}/suspended
Parameters
Path Parameters
| Name | Description |
|---|---|
| id | The id of the job definition to activate or suspend. |
Request Body
A JSON object with the following properties:
| Name | Description |
|---|---|
| suspended | A Boolean value which indicates whether to activate or suspend a given job definition. When the value is set to true, the given job definition will be suspended and when the value is set to false, the given job definition will be activated. |
| includeJobs | A Boolean value which indicates whether to activate or suspend also all jobs of the given job definition. When the value is set to true, all jobs of the provided job definition will be activated or suspended and when the value is set to false, the suspension state of all jobs of the provided job definition will not be updated. |
| executionDate | The date on which the given job definition will be activated or suspended. If null, the suspension state of the given job definition is updated immediately. By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200. |
* For further information, please see the documentation.
Result
This method returns no content.
Response Codes
| Code | Media type | Description |
|---|---|---|
| 204 | Request successful. | |
| 400 | application/json | Returned if some of the request parameters are invalid, for example if the provided executionDate parameter doesn't have the expected format. See the Introduction for the error response format. |
Example
Request
PUT /job-definition/aJobDefinitionId/suspended
{
"suspended" : true,
"includeJobs" : true,
"executionDate" : "2013-11-21T10:49:45.000+0200"
}
Response
Status 204. No content.