Get Custom Attributes By Names

API Type

REST

HTTP Method

POST

Description

Retrieves a list of process attributes (custom attributes) using their names or Xpaths.

Good to Know

  • Values of IDs and XPaths must be separated by a semicolon (;).

URL Format (OnPremises, PrivateCloud)

https://[domain]:[port]/AgilePointServer/Workflow/GetCustomAttrsByNames

URL Format (OnDemand)

https://[domain]:[port]/AgilePointService/Workflow/GetCustomAttrsByNames

Request Parameters

Name Description
None Not Applicable

Request Body Properties

Name Description

AttrNames
Function:
A group of process attributes names.
Type
string
Accepted Values:
An array of valid process attribute names.

CustomIDs
Function:
Multiple work object IDs specified within a process instance.
Type
string
Accepted Values:
An array of valid work object IDs.

JavaScript Code Example

$("#btnGetCustomAttrsByNames").click(function () {
  
  var JSONObject = {
    CustomIDs: "AAA82AAE37054A1AB469FB480028A7A3;94A76E58E3704BF8AE09A6900C130556",
    AttrNames: "/pd:myFields/pd:orgamount;/pd:myFields/pd:objwithSubArray;/pd:myFields/pd:dept"
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/GetCustomAttrsByNames",
    data: JSON.stringify(JSONObject)
  });
});

Java Code Example

public String GetCustomAttrsByNames() {

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

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

  JSONObject postData = new JSONObject();
  
    postData.put("CustomIDs",
      "AAA82AAE37054A1AB469FB480028A7A3;94A76E58E3704BF8AE09A6900C130556");
    postData.put(
      "AttrNames",
      "/pd:myFields/pd:orgamount;/pd:myFields/pd:objwithSubArray;/pd:myFields/pd:dept");

    return ops.POSTMethod(URI, postData.toString());
  return "";
}

C# Code Example

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

    string jsonRequestdata = "{
      \"CustomIDs\":\"AAA82AAE37054A1AB469FB480028A7A3;
                    94A76E58E3704BF8AE09A6900C130556\",
      \"Name\":\"\\/pd:myFields\\/pd:orgamount;
                 \\/pd:myFields\\/pd:objwithSubArray;
                 \\/pd:myFields\\/pd:dept\"}";

    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 {\"customIDs\":\"827028D244B4F4D9117757492322F5E6\",
                         \"AttrNames\":\"pd:myFields\"} 
                         https://mydomain:9011/AgilePointServer/Workflow/GetCustomAttrsByNames

JSON Response Body Example

[{
  "Key":"AAA82AAE37054A1AB469FB480028A7A3",
  "Value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>
    <ArrayOfNameValue xmlns:xsi=\"http:\/\/www.w3.org/2001/XMLSchema-instance
                                    \"xmlns:xsd=\"http://www.w3.org/2001
                                    /XMLSchema\">
      <NameValue>
        <Name>\/pd:myFields\/pd:orgamount<\/Name>
        <Value xsi:type=\"xsd:string\">100.2<\/Value>
      <\/NameValue>
      <NameValue>
        <Name>\/pd:myFields\/pd:objwithSubArray<\/Name>
        <Value xsi:type=\"xsd:string\"><\/Value>
      <\/NameValue>
      <NameValue>
        <Name>\/pd:myFields\/pd:dept<\/Name>
        <Value xsi:type=\"xsd:string\">Administrator<\/Value>
      <\/NameValue>
    <\/ArrayOfNameValue>"
  }
  {
  "Key":"94A76E58E3704BF8AE09A6900C130556",
  "Value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>
    <ArrayOfNameValue xmlns:xsi=\"http:\/\/www.w3.org/2001/XMLSchema-instance
                                    \"xmlns:xsd=\"http://www.w3.org/2001
                                    /XMLSchema\">
      <NameValue>
       <Name>\/pd:myFields\/pd:orgamount<\/Name>
       <Value xsi:type=\"xsd:string\">190.2<\/Value>
      <\/NameValue>
      <NameValue>
        <Name>\/pd:myFields\/pd:objwithSubArray<\/Name>
        <Value xsi:type=\"xsd:string\"><\/Value>
      <\/NameValue>
      <NameValue>
        <Name>\/pd:myFields\/pd:dept<\/Name>
        <Value xsi:type=\"xsd:string\">Human Resource<\/Value>
      <\/NameValue>
   <\/ArrayOfNameValue>"
}]

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.