Get Custom Attributes By IDs

API Type

REST

HTTP Method

POST

Description

Gets all process attributes (custom attributes) of the specified process attribute IDs.

Good to Know

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

URL Format (OnPremises, Private Cloud)

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

URL Format (OnDemand)

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

Request Parameters

NameDescription
NoneNot Applicable

Request Body Properties

NameDescription

customIDs
Description:
Multiple work object IDs specified within a process instance.
Type
string
Allowed Values:
An array of valid work object IDs.

JavaScript Code Example

$("#btnGetCustomAttrsbyIDs").click(function () {

  var JSONObject = {
    customIDs : "0080D881497C47C19B32BD45967E8ABA;
                 0C98EAF88D1F4F6A8E5E3B1C9A25D8D7;
                 351BC22E020D439AB724123ACB76FCDA"          
  };
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/GetCustomAttrsbyIDs",
    data: JSON.stringify(JSONObject)
  });
  
});

Java Code Example

public String GetCustomAttrsbyIDs() {

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

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

  JSONObject postData = new JSONObject();
  
    postData.put("customIDs", "AAA82AAE37054A1AB469FB480028A7A3");

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

C# Code Example

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

    string jsonRequestdata = "{
      \"customIDs\":\"" + "0080D881497C47C19B32BD45967E8ABA;
      0C98EAF88D1F4F6A8E5E3B1C9A25D8D7;
      351BC22E020D439AB724123ACB76FCDA" + "\"}";

    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\"} 
                         https://mydomain:9011/AgilePointServer/Workflow/GetCustomAttrsbyIDs

Output

Array of KeyValue. Key is customIDs and Value is XML serialized WFCustomAttributes.

JSON Response Body Example

[{
  "Key":"0080D881497C47C19B32BD45967E8ABA",
  "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>Test<\/Name>
        <Value xsi:type=\"xsd:string\">Global Custom Attr<\/Value>
      <\/NameValue>
      <NameValue>
        <Name>URL<\/Name>
        <Value xsi:type=\"xsd:string\">localhost:8888<\/Value>
      <\/NameValue>
    <\/ArrayOfNameValue>"
  },
  {
  "Key":"0C98EAF88D1F4F6A8E5E3B1C9A25D8D7",
  "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>Test<\/Name>
        <Value xsi:type=\"xsd:string\">Process Attr<\/Value>
      <\/NameValue>
      <NameValue>
        <Name>URL<\/Name>
        <Value xsi:type=\"xsd:string\">localhost:7777<\/Value>
      <\/NameValue>
    <\/ArrayOfNameValue>"
  }
  {
  "Key":"351BC22E020D439AB724123ACB76FCDA",
  "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>Test<\/Name>
        <Value xsi:type=\"xsd:string\">Global Custom Attr<\/Value>
      <\/NameValue>
      <NameValue>
        <Name>URL<\/Name>
        <Value xsi:type=\"xsd:string\">localhost:666<\/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.