Activate/Suspend Process Definitions By Key

Activates or suspends process definitions with the given process definition key.

Method

PUT /process-definition/suspended

Parameters

Request Body

A JSON object with the following properties:

Name Description
processDefinitionKey The key of the process definitions to activate or suspend.
suspended A Boolean value which indicates whether to activate or suspend all process definitions with the given key. When the value is set to true, all process definitions with the given key will be suspended and when the value is set to false, all process definitions with the given key will be activated.
includeProcessInstances A Boolean value which indicates whether to activate or suspend also all process instances of the process definitions with the given key. When the value is set to true, all process instances of the process definitions with the given key will be activated or suspended and when the value is set to false, the suspension state of all process instances of the process definitions with the given key will not be updated.
executionDate The date on which all process definitions with the given key will be activated or suspended. If null, the suspension state of all process definitions with the given 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.
404 application/json Process definition with given key does not exist. See the Introduction for the error response format.
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 /process-definition/suspended

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

Response

Status 204. No content.

On this Page: