Get Group

API Type

REST

HTTP Method

GET

Description

Retrieves a group object with the specified group name.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

JavaScript Code Example

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

Java Code Example

public String GetGroup(String GroupName) {

  String URI = "http://mydomain:9011/AgilePointServer/Admin/GetGroup/"
                       + GroupName;

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

  return ops.GETMethod(URI);
}

C# Code Example

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

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

    return ops.GetData(URL);
  }

Output

WFGroup object. If the specified group does not exist, the output is null.

JSON Response Body Example

{
  "GetGroupResult":{
  "CreatedBy":"DEMO3\\administrator",
  "CreatedDate":"\/Date(928149600000)\/",
  "Description":"test",
  "Enabled":true,
  "LastModifiedBy":"",
  "LastModifiedDate":" \/Date(928149600000)\/",
  "Name":"Finance Coordinator",
  "ResponsibleUser":"DEMO3\\administrator"
}}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher