Activate/Suspend Process Instance In Group
Activates or suspends process instances synchronously with a list of process instance ids, a process instance query, and/or a historical process instance query
Method
PUT /process-instance/suspended
Parameters
Request Body
A JSON object with the following properties:
| Name | Description |
|---|---|
| processInstanceIds | A list of process instance ids which defines a group of process instances which will be activated or suspended by the operation. |
| processInstanceQuery | A process instance query which defines a group of process instances which will be activated or suspended by the operation. See GET /process-instance |
| historicProcessInstanceQuery | A historical process instance query which defines a group of process instances which will be activated or suspended by the operation. See GET history/process-instance |
| suspended | A Boolean value which indicates whether to activate or suspend all process instances that were defined with the other parameters. When the value is set to true, all process instances defined will be suspended and when the value is set to false, all process instances defined 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 processInstanceIds, processInstanceQuery, and historicProcessInstanceQuery parameters are all set to null. See the Introduction for the error response format. |
Example
Request
PUT /process-instance/suspended
{
"processInstanceIds" : [
"processInstanceId1",
"processInstanceId2",
...
"processInstanceIdn"
],
"suspended" : true
}
Response
Status 204. No content.