Get Process Instance Attribute

API Type

Web Services

Description

Retrieves a single attribute for a specified process instance.

Syntax

public virtual KeyValue GetProcInstAttr(string processInstanceID, string attributeName)

Parameters

Name	Description
processInstanceID	Definition: Specifies the unique ID of a process instance. Type string Allowed Values: A valid process instance ID
attributeName	Definition: The name of the process instance attribute you want. Type string Allowed Values: DefID - The ID of the process definition. DefName - The name of the process definition. ProcInstName - The name of the process instance. Status - The current status of the process instance. SuperProcInstID - The parent process instance ID. workObjectID - The ID of the work object. StartDate - The date and time when the process instance was started. DueDate - The date that the process instance is expected to be complete. LastModifiedDate - The date and time that the last modification was made to the process instance.

Name

Description

processInstanceID

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

attributeName

Definition:

The name of the process instance attribute you want.

Type

string

Allowed Values:

DefID - The ID of the process definition.
DefName - The name of the process definition.
ProcInstName - The name of the process instance.
Status - The current status of the process instance.
SuperProcInstID - The parent process instance ID.
workObjectID - The ID of the work object.
StartDate - The date and time when the process instance was started.
DueDate - The date that the process instance is expected to be complete.
LastModifiedDate - The date and time that the last modification was made to the process instance.

Output

Returns the KeyValue for the attribute associated with the process instance as a name-value" pair.

Example

//This is console application sample
IWFWorkflowService svc = GetWorkflowService();
string processInstanceID = …// for example,
"1e3d514d43d3465cae6ec3bbbd409168";
string attributeName = "DefName";

try
    {
    //Returns attribute associated with the Process Instance as 
    "Name-Value" pair.
    KeyValue processInstanceAttribute =
    svc.GetProcInstAttr(processInstanceID, attributeName);
    Console.WriteLine("{0}={1}", processInstanceAttribute.Name,+
    processInstanceAttribute.Value);
    }

catch (Exception ex)
    {
    Console.WriteLine(ShUtil.GetSoapMessage(ex));
    }

Supported Versions

3.2.0.4 and higher