Deleting a process instance has the same effect as terminating an instance via the modeller interface. The specified instances end but their data (variables and their values etc) is retained. To delete an instance that has ended, use deleteHistoricProcessInstances.
Parameters
| Name | Type | Description |
|---|---|---|
| processInstanceIds | String | Comma separated list of active process IDs to terminate |
| deleteReason | String | Deletion reason, this can be used to record the reason the processes were deleted |
| updateHistory | Boolean | Default true. Whether or not any histories written by the process instances should be updated with a final summary event. Set this as false if you are planning on deleting the histories too to improve performance |
| processInstanceIds must be supplied | ||
Last modified on January 02, 2024
Share this page
