Get Groups

API Type

REST

HTTP Method

GET

Description

Retrieves all the group objects in the system.

URL Format (On Premises)

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

Request Parameters

Name	Description
None	Not Applicable

JavaScript Code Example

$("#btnGetGroups").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/GetGroups",
    type: "GET"
  });
  
});

Java Code Example

public String GetGroups() {

  String URI = "http://mydomain:9011/AgilePointServer/Admin/GetGroups";

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

  return ops.GETMethod(URI);
}

C# Code Example

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

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

    return ops.GetData(URL);
  }

Output

An Array of WFGroup objects.

JSON Response Body Example

{
  "GetGroupsResult":[{
  "CreatedBy":"DEMO3\\administrator",
  "CreatedDate": "\/Date(928149600000)\/",
  "Description":"test123",
  "Enabled":true,
  "LastModifiedBy":"DEMO3\\administrator",
  "LastModifiedDate": "\/Date(928149600000)\/",
  "Name":"Test1",
  "ResponsibleUser":"DEMO3\\administrator"
 }]
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher