Get Custom Attribute by ID

API Type

REST

HTTP Method

POST

Description

Retrieves a process attribute (custom attribute) with the specified process attribute ID and process attribute name.

URL Format (OnPremises, Private Cloud)

https://[domain]:[port]/AgilePointServer/Workflow/GetCustomAttr/[customID]

URL Format (OnDemand)

https://[domain]:[port]/AgilePointService/Workflow/GetCustomAttr/[customID]

Request Parameters

NameDescription

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

Request Body Properties

NameDescription

attrName
Description:
The name of an item, such as a property or attribute in a name/value pair.
Type
string
Allowed Values:
A valid name.

JavaScript Code Example

$("#btnGetCustomAttr").click(function () {
  
  var JSONObject = { 
    attrName: "/pd:myFields/pd:orgamount"};
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                 GetCustomAttr/AAA82AAE37054A1AB469FB480028A7A3",
    data: JSON.stringify(JSONObject)
  });
  
});

Java Code Example

public String GetCustomAttr() {

  String URI = "https://mydomain:9011/AgilePointServer/Workflow/
                        GetCustomAttr/AAA82AAE37054A1AB469FB480028A7A3";

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

  JSONObject postData = new JSONObject();
  
    postData.put("attrName", "/pd:myFields/pd:orgamount");
    return ops.POSTMethod(URI, postData.toString());
  return "";
}

C# Code Example

public string GetCustomAttr()
  {
    string URL = "https://mydomain:9011/AgilePointServer/Workflow/
                         GetCustomAttr/AAA82AAE37054A1AB469FB480028A7A3";

    string jsonRequestdata = "{
      \"attrName\":\"" + "/pd:myFields/pd:file" + "\"}";

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

    return ops.POSTMethod(URL, jsonRequestdata);
  }

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 --header "Content-Type: application/json" 
                         --header "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         --request POST 
                         --data {\"CUSTOMID\":\"827028D244B4F4D9117757492322F5E6\"} 
                         https://mydomain:9011/AgilePointServer/Workflow/
                         GetCustomAttr/827028D244B4F4D9117757492322F5E6

Output

Custom attribute value (can be string, integer, float, double, bool, and/or DateTime).

JSON Response Body Example

"100.2"

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.