Suspends an active process definition and optionally suspends any active instances of it.
When a process definition is suspended it is not possible to start new process instances using that process definition. It can be used on a specific process definition ID or on all processes matching a supplied processDefinitionKey.
Parameters
| Name | Type | Description |
|---|---|---|
| processDefinitionId | String | Full process definition ID of the process to suspend |
| processDefinitionKey | String | Process definition key of the process to suspend |
| suspendProcessInstances | Boolean | Defaults to false. If true any active instances of the process definition will also be suspended |
| processDefinitionId or processDefinitionKey must be supplied | ||
Last modified on February 04, 2022
Share this page
