Get Custom Attributes

API Type

Web Services

Description

Retrieves a collection of custom attributes for a specified custom ID in XML format.

Syntax

public virtual string GetCustomAttrs(string customID)

Parameters

Name Description

customID

Definition:
A work object ID specified within a process instance.
Type
string
Allowed Values:
One valid work object ID.

Output

string that contains all the attributes for the custom ID in XML format.

Example

// get custom attributes in xml format
IWFWorkflowService svc = GetWorkflowService();
string customID = …// for example, "013933F128C3415F81D6F545594D4CB6";

try
	{
    string xml = svc.GetCustomAttrs(sessionID, string processInstanceID);
    Console.WriteLine("AttributeXMLstring={0}",resultAttrXML);
    WFCustomAttributes attrs = new WFCustomAttributes();
    attrs.AttrXml = xml; // de-serialize xml
    string[] attributeNames = attrs.GetNames();// get attribute names
    Object value = attrs["MyAttributeName"]; // retrieve attribute value
	}

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

Supported Versions

3.2.0.4 and higher