Get Domain Groups

API Type

REST

HTTP Method

POST

Description

Retrieves all the domain group objects.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Admin/GetDomainGroups

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Admin/GetDomainGroups

Request Parameters

Request Body Properties

JavaScript Code Example

$("#btnGetDomainGroups").click(function () {
  var JSONObject = {
    LDAPPath: "LDAP:\/\/DC=DEMO3,DC=com",
    Filter: ""
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/GetDomainGroups",
    data: JSON.stringify(JSONObject)
  });
});

Java Code Example

public String GetDomainGroups() {

  String URI = "https://mydomain:9011/AgilePointServer/Admin/GetDomainGroups";

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

  
    JSONObject postData = new JSONObject();
    postData.put("LDAPPath", "LDAP:\\/\\/DC=DEMO3,DC=com");
    postData.put("Filter", "");

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

C# Code Example

public string GetDomainGroups()
  {
    string jsonRequestData = "{
      \"LDAPPath\":\"LDAP:\\/\\/DC=demo3,
      DC=com\",
      \"Filter\":\"\"}";

    string URL = "https://mydomain:9011/AgilePointServer/Admin/GetDomainGroups";

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

    return ops.POSTMethod(URL, jsonRequestData);
  }

Output

Array of KeyValue objects. If the specified group is not found, the output is null.

JSON Response Body Example

[{
  "Key":"String content",
  "Value":"String content"
}]

Supported Versions

AgilePoint BPMS v5.0 R2 and higher