Activate/Suspend Process Instance By Id

Activate or suspend a given process instance.

Method

PUT /process-instance/{id}/suspended

Parameters

Path Parameters

Name Description
id The id of the process instance 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 process instance. When the value is set to true, the given process instance will be suspended and when the value is set to false, the given process instance will be activated.

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful.

Example

Request

PUT /process-instance/aProcessInstanceId/suspended

{
  "suspended" : true
}

Response

Status 204. No content.

On this Page: