Update Role

API Type

REST

HTTP Method

POST

Description

Updates the description or access right selections of a role.

URL Format (OnPremises, Private Cloud)

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

URL Format (OnDemand)

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

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
Description	Description: A description of an entity. Type string Allowed Values: A string that can contain spaces and special characters.
Enabled	Description: Enables or disables an entity. Type bool Allowed Values: True - Enables the entity. False - Disables the entity.
Rights	Description: Specifies the rights that are assigned to the Role. Type WFAccessRights Allowed Values: An array of index values. See the table for appropriate indexes. WFAccessRights provides the enums for rights. See the sample code for more information.
RoleName	Description: The name of a role. Type string Allowed Values: A valid role name.

These properties are based on the class AddUpdateRoleHelper

JavaScript Code Example

$("#btnUpdateRole").click(function () {
  
  var JSONObject = {
    RoleName: "testasd12", 
    Description: "test", 
    Enabled: true, 
    Rights: ["InitiateProcessInstance", "CancelProcessInstance"]
  }; 
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/UpdateRole",
    data: JSON.stringify(JSONObject)
  });
  
});

Java Code Example

public String UpdateRole() {

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

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

  JSONObject postData = new JSONObject();
  
    postData.put("RoleName", "Regional Managers");
    postData.put("Description", "Regional Managers");
    postData.put("Enabled", "true");
    JSONArray rights = new JSONArray();
    String[] Rights = { "InitiateProcessInstance",
      "CancelProcessInstance" };
    for (String temp : Rights) {
      rights.put(temp);
    }
    postData.put("Rights", rights);
    return ops.POSTMethod(URI, postData.toString());
  return "";
}

C# Code Example

public string UpdateRole()
  {

    string URL = "https://mydomain:9011/AgilePointServer/Admin/UpdateRole";

    string jsonRequestData = "{
      \"RoleName\":\"" + "RoleToBeUpdated" + "\",
      \"Description\":\"" + "test" + "\",
      \"Enabled\":\"true\",
      \"Rights\": [\"InitiateProcessInstance\",
      \"CancelProcessInstance\"]}";

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

    return ops.POSTMethod(URL, jsonRequestData);
  }

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 --header "Content-Type: application/json" 
                         --header "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         --request POST 
                         --data {\"RoleName\":\"Regional Managers\",
                         \"Description\":\"Updates information for my role\",
                         \"Enabled\":\"true\",
                         \"Rights\":\"[]\"} 
                         https://mydomain:9011/AgilePointServer/Admin/UpdateRole

Output

An updated WFRole object.

JSON Response Body Example

{
  "CreatedBy": "mydomain\\HR"
  "CreatedDate": "\/Date(928149600000)\/",
  "Description": "test"
  "Enabled": true
  "LastModifiedBy": "mydomain\\administrator"
  "LastModifiedDate": "\/Date(928149600000)\/",
  "Name": "testasd12"
  "RightFlags": "YYNNNNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNN"
}

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.