Activate/Suspend Process Instance By Process Definition Id

Activates or suspends process instances with the given process definition id.

Method

PUT /process-instance/suspended

Parameters

Request Body

A JSON object with the following properties:

Name Description
processDefinitionId The process definition id of the process instances to activate or suspend.
suspended A Boolean value which indicates whether to activate or suspend the process instances with the given process definition id. When the value is set to true, the process instances with the given process definition id will be suspended and when the value is set to false, the process instances with the given process definition id will be activated.

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

Example

Request

PUT /process-instance/suspended

{
  "processDefinitionId" : "aProcDefId",
  "suspended" : true
}

Response

Status 204. No content.

On this Page: