Get Access Right Names

API Type

REST

HTTP Method

GET

Description

Retrieves the names of all the access rights in the AgilePoint system.

URL Format (OnPremises, Private Cloud)

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

URL Format (OnDemand)

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

Request Parameters

NameDescription
NoneNot Applicable

JavaScript Code Example

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

Java Code Example

public String GetAccessRightNames() {

  String URI = "https://mydomain:9011/AgilePointServer/Admin/GetAccessRightNames";

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

  return ops.GETMethod(URI);
}

C# Code Example

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

    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/GetAccessRightNames

Output

An array of strings that contain the names of all the access rights for the system.

JSON Response Body Example

{
  "GetAccessRightNamesResult":[
  "Register and modify the user information",
  "Unregister a user",
  "Add and modify the role information",
  "Remove a role",
  "Add and modify the group information",
  "Remove a group",
  "Modify\/View the system configuration",
  "Add a process template",
  "Checkin and checkout a process template",
  "Delete and disable a process template",
  "Release a process template",
  "Initiate a process",
  "Suspend and resume a process",
  "Resend and cancel an email notification",
  "Cancel a process",
  "Rollback a process",
  "Reassign a task",
  "Cancel a task",
  "Create a task",
  "Add, remove, and modify delegation",
  "Add, remove, and modify report configuration",
  "Archive and restore process(es)",
  "Add, remove, and modify shared custom attributes",
  "View Process details",
  "Modify custom attributes*",
  "View custom attributes*",
  "Allow to execute QueryDatabase() and QueryDatabaseEx()*",
  "Mark automatic work item completion*",
  "Save or remove temporary file*"
]}

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.