Get Process Instance

API Type

Web Services

Description

Retrieves basic information about a specified process instance.

Syntax

public virtual WFBaseProcessInstance GetProcInst(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

WFBaseProcessInstance object that contains basic information about a process instance. It returns null if the process instance ID does not exist.

Example

// This is sample code for console application
IWFWorkflowService svc = GetWorkflowService();
string processInstanceID = …// process instance ID

try
	{
    //Returns an instance of WFBaseProcessInstance type.
    WFBaseProcessInstance processInstance =
    svc.GetProcInst(processInstanceID);
	}

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

Supported Versions

3.2.0.4 and higher