Delete Process Instance

Deletes a running process instance by id.

Method

DELETE /process-instance/{id}

Parameters

Path Parameters

Name Description
id The id of the process instance to be deleted.

Query Parameters

Name Description
skipCustomListeners If set to true, the custom listeners will be skipped.
skipIoMappings If set to true, the input/output mappings will be skipped.
skipSubprocesses If set to true, subprocesses related to deleted processes will be skipped.
failIfNotExists If set to false, the request will still be successful if the process id is not found.

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful.
404 application/json Process instance with given id does not exist. See the Introduction for the error response format.

Example

Request

DELETE /process-instance/aProcessInstanceId

Response

Status 204. No content.

On this Page: