Get Process Instance Attributes

API Type

Web Services

Description

Gets the name-value pairs of process attributes (custom attributes) with the specified process instance ID.

Syntax

public virtual NameValue[] GetProcInstAttrs(String processInstanceID)

Parameters

NameDescription

processInstanceID
Function:
A process instance ID for the process instance you are creating.
Type
string
Accepted Values:
A unique, 32 character process instance ID.

If you set this value to null, the AgilePoint Server generates the ID.

Attributes

NameDescription
DefIDThe ID of the process definition.
DefNameThe name of the process definition.
ProcInstNameThe name of the process instance.
StatusThe current status of the process instance.
SuperProcInstIDThe parent process instance ID.
workObjectIDThe ID of the work object.
StartDateThe date and time when the process instance was started.
DueDateThe date that the process instance is expected to be complete
LastModifiedDateThe date and time that the last modification was made to the process instance.

Output

Array of NameValue objects that holds the values of all the requested attributes.

Example

// This is console application sample
IWFWorkflowService svc = GetWorkflowService();
string processInstanceID = …// process instance ID
NameValue[] attributes = svc.GetProcInstAttrs(processInstanceID);
for (int i = 0; i < attributes.Length; i++)
	{
    NameValue nv = attributes[i];
    Console.WriteLine("Process Instance Attribute, {0}={1}", nv.Name, nv.Value);
	}

Supported Versions

3.2.0.4 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.