listProcessInstanceAttributes

Syntax

com.tibco.wcc.base.Requests.listProcessInstanceAttributes(requestId,
                                                     txtProcessName,
                                                     txtModuleName,
                                                     txtVersion,
                                                     selType);

Parameters

• requestId - (String) Uniquely identifies the request. For more information, see Submitting Server Requests.
• txtProcessName - (String) The name of the process template whose instance’s attributes are to be returned.
• txtModuleName - (String) The path to the XPDL file that defines the “process package”.
• txtVersion - (String) The version of the process template.
• selType - (Number) Specifies the type of attributes to return. 1 = filter attributes; 2 = sort attributes; 3= both filter and sort attributes.

Returns

Returns an <ap:InstanceAttribute> element for each process instance attribute returned. The <ap:InstanceAttribute> element contains the following elements:

• <ap:ModuleName> - The path to the XPDL file that defines the “process package”.
• <ap:ProcessName> - The name of the process template.
• <ap:Version> - The version of the process template.
• <ap:Name> - The name of the attribute.
• <ap:Type> - The type of data stored in the attribute.

For example:

<ap:Requests>
  <ap:InstanceAttributes Id="ApiSample.listProcessInstanceAttributes">
    <ap:InstanceAttribute>
      <ap:ModuleName>/CSCallback/Process Packages/CSCallback.xpdl</ap:ModuleName>
      <ap:ProcessName>CSCallbackProcess</ap:ProcessName>
      <ap:Version>1.0.0.201101101507</ap:Version>
      <ap:Name>ResolutionDetails</ap:Name>
      <ap:Type>string</ap:Type>
    </ap:InstanceAttribute>
                 .
                 .
                 .
  </ap:InstanceAttributes>
</ap:Requests>