Delete a Process Instance - Delete a Process Instance - This operation builds a delete-process request payload. Use it to request deletion of a process instance - Content Innovation Cloud - Hyland Automate Modeler - Current/Hyland-Automate-Modeler/vwu3254861458878 - Current - Current

Hyland Automate Modeler

Platform
Content Innovation Cloud
Product
Hyland Automate Modeler
Release
Current
License
ft:lastPublication
2026-11-16T23:02:28.533499
ft:locale
en-US

This operation builds a delete-process request payload. Use it to request deletion of a process instance

The base command is:

processPayloadBuilder.delete()

You can use the following options:

Option Description
withProcessInstance(processInstance: ProcessInstance) Specifies the process instance to delete.
withProcessInstanceId(processDefinitionId: string) Specifies the ID of the process instance to delete.
withReason(reason: string) Provides a reason for deleting the process instance.

The following is the command example:

processPayloadBuilder
    .delete()
    .withProcessInstanceId(variables.processInstanceId)
    .build();

The processPayloadBuilder.delete() creates a delete-process payload builder. withProcessInstanceId(variables.processInstanceId) specifies the process instance to delete by using the value stored in the processInstanceId process variable. build() creates the final command payload that can be sent to the runtime command channel.