Get Group Members

API Type

REST

HTTP Method

GET

Description

Retrieves the members of a specified group.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Admin/GetGroupMembers/[groupName]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Admin/GetGroupMembers/[groupName]

Request Parameters

Name	Description
groupName	Definition: Specifies the name of a group. Type string Allowed Values: A valid group name.

JavaScript Code Example

$("#btnGetGroupMembers").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/
                GetGroupMembers/Finance Coordinator",
    type: "GET"
  });
  
});

Java Code Example

public String GetGroupMembers(String groupName) {

  String URI = "http://mydomain:9011/AgilePointServer/Admin/GetGroupMembers/"
                       + groupName;

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

  return ops.GETMethod(URI);
}

C# Code Example

public string GetGroupMembers()
  {
    string URL = "http://mydomain:9011/AgilePointServer/Admin/
                         GetGroupMembers/Users";

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

    return ops.GetData(URL);
  }

Output

An array of WFGroupMember objects.

JSON Response Body Example

{
  "GetGroupMembersResult":[{
  "ClientData":"",
  "CreatedBy":"DEMO3\\administrator",
  "CreatedDate": "\/Date(928149600000)\/",
  "Description":"",
  "Enabled":true,
  "Member":"DEMO3\\administrator",
  "Name":"Finance Coordinator"
 }]
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher