Resume Process Instance

API Type

Web Services

Description

Resumes a suspended process instance. The process instance status is changed to running, and the statuses of all the work items (tasks) become Active.

Syntax

public virtual WFEvent ResumeProcInst(String processInstanceID)

Parameters

Name Description

processInstanceID

Definition:
Specifies the unique ID of a process instance.
Type
string
Allowed Values:
A valid process instance ID

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.ResumeProcInst(processInstanceID);
	}

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

Supported Versions

3.2.0.4 and higher