Suspend Process Instance

Description

Suspends a process instance with the specified process instance ID.

Good to Know

• The process instance status is changed to Suspended, and the statuses of all the work items (tasks) become Pending.
• To call this method, the API account user must have the access right, Suspend and Resume a Process.
• Only running process instances can be suspended.
• If there is a parent-child hierarchy, and the parent process instance is suspended, the running child process instances are suspended automatically.

Syntax

public virtual WFEvent SuspendProcInst(string processInstanceID)

Parameters

Output

WFEvent object that provides the status of the transaction. The possible statuses are:

• Sent - Indicates event has been sent to engine for processing.
• Failed - Indicates event failed to process.
• Processed - Indicates event has been processed successfully.
• Canceled - Indicates event was canceled.
• Deferred - Indicates event does not need to be sent immediately.

Example

// This is console application sample
IWFWorkflowService svc = GetWorkflowService();

try
	{
    string processInstanceID = …// process instance to be suspended.
    WFEvent event = svc.SuspendProcInst(processInstanceID);
	}

catch (Exception ex)
	{
    Console.WriteLine("Failed: " + ShUtil.GetSoapMessage(ex));
	}

Supported Versions

3.2.0.4 and higher