Get Role

API Type

REST

HTTP Method

GET

Description

Retrieves a role object by name.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Admin/GetRole/[roleName]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Admin/GetRole/[roleName]

Request Parameters

JavaScript Code Example

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

Java Code Example

public String GetRole() {

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

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

  return ops.GETMethod(URI);
}

C# Code Example

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

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

    return ops.GetData(URL);
  }

Output

WFRole object with the specified role name.

JSON Response Body Example

{
  "GetRoleResult":{
  "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
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNN"
 }
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher