Where does process instance property 'deleteReason' come from?

Hi,

According to the doc, the REST API POST /history/process-instance returns a list of process instance objects containing a property deleteReason:

The provided delete reason in case the process instance was canceled during execution.

However, I can not find how to set the property as the RESP API DELETE /history/process-instance/{id} does not take any other parameters. And when I delete a process from the cockpit, the UI does not prompt me for a delete reason either.

So what this property is for and how to set?

Hi @Yuan_HOng,

Via Rest API please check the POST [1]

Currently this is not possible.

[1] https://docs.camunda.org/manual/latest/reference/rest/process-instance/post-delete/

Best regards,
Yana

The delete reason can be set by the java api: https://docs.camunda.org/javadoc/camunda-bpm-platform/7.9/org/camunda/bpm/engine/RuntimeService.html#deleteProcessInstance(java.lang.String,%20java.lang.String)

1 Like