Get Process Instance Attribute by Name

API Type

REST

HTTP Method

GET

Description

Gets the name-value pair of the specified process attribute (custom attribute) for the specified process instance ID.

URL Format (OnPremises, Private Cloud)

https://[domain]:[port]/AgilePointServer/Workflow/GetProcInstAttr/[processInstanceID]/[attributeName]

URL Format (OnDemand)

https://[domain]:[port]/AgilePointService/Workflow/GetProcInstAttr/[processInstanceID]/[attributeName]

Request Parameters

NameDescription

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

attributeName
Description:
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.

JavaScript Code Example

$("#btnGetProcInstAttr").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                GetProcInstAttr/0FD3088F40B640D4AFE41AEEBDAE914B/DueDate",
    type: "GET"
  });
  
});

Java Code Example

public String GetProcInstAttr() {

  String URI = "https://mydomain:9011/AgilePointServer/Workflow/
                        GetProcInstAttr/0FD3088F40B640D4AFE41AEEBDAE914B/DueDate";

  HTTPOperations ops = new HTTPOperations(domain, userName, 
                       password, appID, locale);

  return ops.GETMethod(URI);
}

C# Code Example

public string GetProcInstAttr()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Workflow/
                         GetProcInstAttr/0FD3088F40B640D4AFE41AEEBDAE914B/DueDate";

    HTTPOperations ops = new HTTPOperations(domain, this.userName, 
                         password, appID, locale);

    return ops.GetData(URI);
  }

cURL Code Example

Note: The authorization code is an example. You must generate your own authorization code in base64 encoded format with the syntax Domain\Username:Password. 
curl -H "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         https://mydomain:9011/AgilePointServer/Workflow/
                         GetProcInstAttr/827028D244B4F4D9117757491D0C4F53/DueDate

Output

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

JSON Response Body Example

{
  "GetProcInstAttrResult":
  {
    "Name":"DueDate",
    "Value":"1\/17\/2014 3:55:00 PM"
  }
}

Supported Versions

AgilePoint v5.0 R2 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.