Get Roles

API Type

REST

HTTP Method

GET

Description

Retrieves a list of all roles in the system.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
None	Not Applicable

JavaScript Code Example

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

Java Code Example

public String GetRoles() {

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

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

  return ops.GETMethod(URI);
}

C# Code Example

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

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

    return ops.GetData(URL);
  }

Output

An array of WFRole objects that includes all roles.

JSON Response Body Example

{
  "GetRolesResult":[{
  "CreatedBy: "DEMO3\\administrator"
  "CreatedDate": "\/Date(928149600000)\/",
  "Description: "Administrators have complete access to maintain system"
  "Enabled": true
  "LastModifiedBy": "DEMO3\\administrator"
  "LastModifiedDate": "\/Date(928149600000)\/",
  "Name": "Administrators"
  "RightFlags": "YYYYYYYYYYYYYYYYYYYYYYYY
                NNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNN"
  }
  {
  "CreatedBy": "DEMO3\\HR"
  "CreatedDate": "\/Date(928149600000)\/",
  "Description": "Administrators have complete access to maintain system"
  "Enabled": true
  "LastModifiedBy": "DEMO3\\administrator"
  "LastModifiedDate": "\/Date(928149600000)\/",
  "Name: "Administrators"
  "RightFlags": "YYYYYYYYYYYYYYYYYYYYYYYY
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNN"
  }
]}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher