Get Role by Name

API Type

REST

HTTP Method

GET

Description

Retrieves a role object by the AgilePoint role name.

URL Format (OnPremises, PrivateCloud)

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

URL Format (OnDemand)

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

Request Parameters

Name Description

roleName
Function:
The name of a role.
Type
string
Accepted Values:
A valid role name.

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 = "https://mydomain:9011/AgilePointServer/Admin/
                        GetRole/Administrators";

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

  return ops.GETMethod(URI);
}

C# Code Example

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

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

    return ops.GetData(URL);
  }

cURL Code Example

Note: The authorization code is an example. You must generate your own authorization code in base64 encoded format with the syntax Domain\Username:Password. 
curl -H "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         https://mydomain:9011/AgilePointServer/Admin/
                         GetRole/sample

Output

WFRole object with the specified role name.

JSON Response Body Example

{
  "GetRoleResult":{
  "CreatedBy: "mydomain\\administrator"
  "CreatedDate": "\/Date(928149600000)\/",
  "Description: "Administrators have complete access to maintain system"
  "Enabled: true
  "LastModifiedBy: "mydomain\\administrator"
  "LastModifiedDate": "\/Date(928149600000)\/",
  "Name: "Administrators"
  "RightFlags": "YYYYYYYYYYYYYYYYYYYYYYYY
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNN"
 }
}

Supported Versions

AgilePoint v5.0 R2 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.