suspendProcessInstance

This method suspends the specified process instance.

This causes the process instance’s status to change to Suspended. It also results in all work items associated with the process instance to also become suspended; when suspended, they cannot be opened.

Note that work items that have a state of Suspended are hidden in the work item list. The View menu on the work item list provides selections that allow the user to display visible and/or hidden work items.

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

Also see: resumeProcessInstance.

Syntax

suspendProcessInstance(id,
                       suppressConfirm);
suspendProcessInstance(ids,
                       suppressConfirm);

Parameters

  • id - (String) A process instance ID, identifying the process instance to suspend.
  • 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 suspend.

Returns

none