cancelProcessInstance

This method cancels the specified process instance. This results in all work items associated with that process instance also being cancelled — they are removed from work lists of all users to whom they were offered or allocated.

This method has two signatures: one to cancel a single process instance, and one to cancel multiple process instances.

Syntax

cancelProcessInstance(id,
                      suppressConfirm);

cancelProcessInstance(ids,
                      suppressConfirm);

Parameters

  • id - (String) A process instance ID, identifying the process instance to cancel.
  • suppressConfirm - (boolean) (optional) If true, suppresses the confirmation message. If false (the default), the confirmation message is displayed.
  • ids - (String[]) An array of process instances IDs, identifying the process instances to cancel.

Returns

none