Activate/Suspend Process Instance By Process Definition Key
Activates or suspends process instances with the given process definition key.
Method
PUT /process-instance/suspended
Parameters
Request Body
A JSON object with the following properties:
| Name | Description |
|---|---|
| processDefinitionKey | The process definition key of the process instances to activate or suspend. |
| processDefinitionTenantId | Only activate or suspend process instances of a process definition which belongs to a tenant with the given id. |
| processDefinitionWithoutTenantId | Only activate or suspend process instances of a process definition which belongs to no tenant. Value may only be true, as false is the default behavior. |
| suspended | A Boolean value which indicates whether to activate or suspend all process instances with the given process definition key. When the value is set to true, all process instances with the given process definition key will be suspended and when the value is set to false, all process instances with the given process definition key 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 processDefinitionKey parameter is null. See the Introduction for the error response format. |
Example
Request
PUT /process-instance/suspended
{
"processDefinitionKey" : "aProcDefKey",
"suspended" : true
}
Response
Status 204. No content.