Activate/Suspend Job Definitions By Process Definition Key

Activate or suspend job definitions with the given process definition key.

Method

PUT /job-definition/suspended

Parameters

Request Body

A JSON object with the following properties:

Name Description
processDefinitionKey The process definition key of the job definitions to activate or suspend.
suspended A Boolean value which indicates whether to activate or suspend all job definitions with the given process definition key. When the value is set to true, all job definitions with the given process definition key will be suspended and when the value is set to false, all job definitions with the given process definition key will be activated.
includeJobs A Boolean value which indicates whether to activate or suspend also all jobs of the job definitions with the given process definition key. When the value is set to true, all jobs of the process definitions with the given process definition key will be activated or suspended and when the value is set to false, the suspension state of all jobs of the process definitions with the given process definition key will not be updated.
executionDate The date on which all job definitions with the given process definition key will be activated or suspended. If null, the suspension state of all job definitions with the given process definition key is updated immediately. The date must have the format yyyy-MM-dd'T'HH:mm:ss, e.g., 2013-01-23T14:42:45.

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 or if the processDefinitionKey parameter is null. See the Introduction for the error response format.

Example

Request

PUT /job-definition/suspended

{
  "processDefinitionKey" : "aProcessDefinitionKey",
  "suspended" : true,
  "includeJobs" : true,
  "executionDate" : "2013-11-21T10:49:45"
}

Response

Status 204. No contCnt.

On this Page: