Delete Definitions By Key

Deletes process definitions by a given key.

Method

  1. DELETE /process-definition/key/{key}/delete
    Deletes process definitions which belong to no tenant id by a given key.

  2. DELETE /process-definition/key/{key}/tenant-id/{tenant-id}/delete
    Deletes process definitions which belong to a tenant id by a given key.

Parameters

Path Parameters

Name Description
key The key of the process definitions to be deleted.
tenant-id The id of the tenant the process definitions belong to.

Query Parameters

Name Description
cascade true, if all process instances, historic process instances and jobs of the process definitions should be deleted.
skipCustomListeners true, if only the built-in ExecutionListeners should be notified with the end event.
skipIoMappings A boolean value to control whether input/output mappings should be executed during deletion. true, if input/output mappings should not be invoked.

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful. No content.
403 application/json The process definitions with the given key cannot be deleted due to missing permissions. See the Introduction for the error response format.
404 application/json No process definition with the given key exists. See the Introduction for the error response format.

Example

Request

DELETE /process-definition/key/invoice/delete?cascade=true&skipCustomListeners=true&skipIoMappings=true

DELETE /process-definition/key/invoice/tenant-id/tenant1/delete?cascade=true&skipCustomListeners=true&skipIoMappings=true

Response

Status 204. No content.

On this Page: