Get Custom Attributes By Names

API Type

REST

HTTP Method

POST

Description

Retrieves a list of custom attributes using their names or xpaths.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
AttrNames	Definition: A group of process attributes names. Type string Allowed Values: An array of valid process attribute names.
CustomIDs	Definition: Multiple work object IDs specified within a process instance. Type string Allowed 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 CustomIDs, String AttrNames) {

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

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

  JSONObject postData = new JSONObject();
  try {
    postData.put("CustomIDs", CustomIDs);
    postData.put("AttrNames", AttrNames);

    return ops.POSTMethod(URI, postData.toString());
  } catch (JSONException e1) {
    e1.printStackTrace();
  }
  return "";
}

C# Code Example

public string GetCustomAttrsByNames()
  {
    string URL = "http://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);
  }

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 BPMS v5.0 R2 and higher