Get Custom Attributes By ID

API Type

REST

HTTP Method

GET

Description

Gets all the custom attributes with the specified array of custom IDs.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

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

JavaScript Code Example

$("#btnGetCustomAttrsByID").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                GetCustomAttrsByID/00084509E95E4A72B51A602DB6EA182C",
    type: "GET"
  });
  
});

Java Code Example

public String GetCustomAttrsByID(String customID) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/GetCustomAttrsbyID/"
                       + customID;

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

  return ops.GETMethod(URI);
}

C# Code Example

public string GetCustomAttrsByID()
  {
    string URL = "http://mydomain:9011/AgilePointServer/Workflow/
                         GetCustomAttrsByID/FE6F63E224174FE9BD8B30A8ADCB0434";

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

    return ops.GetData(URL);
  }

Output

XML Serialized object of custom attributes with the specified custom id.

JSON Response Body Example

{
  "GetCustomAttrsByIDResult": "<?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>"	
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher