Add Role

API Type

REST

HTTP Method

POST

Description

Adds a role to the AgilePoint system.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
RoleName	Definition: The name of a role. Type string Allowed Values: A valid role name.
Description	Definition: A free text description of an entity. Type string Allowed Values: A string that can contain spaces and special characters.
Rights	Definition: 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.
Enabled	Definition: Enables or disables an entity. Type bool Allowed Values: True - Enables the entity. False - Disables the entity.

Access Rights

Index	Rights
0	Register and modify the user information
1	Unregister a user
2	Add and modify role information
3	Remove a role
4	Add and modify group information
5	Remove a group
6	Modify and view system information
7	Add a process definition
8	Check in and check out a process definition
9	Delete or disable a process definition
10	Release a process definition
11	Initiate a process
12	Suspend and resume a process
13	Resend and cancel an email notification
14	Cancel a process
15	Rollback a process
16	Reassign a task
17	Cancel a task
18	Create a task
19	Add, remove and modify delegation
20	Add, remove and modify report configuration
21	Achieve and restore processes
22	Add, remove and modify shared custom attributes
23	View process details

JavaScript Code Example

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

Java Code Example

public String AddRole(String RoleName, 
  String Description, boolean Enabled,
  String[] Rights) {

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

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

  try {
    JSONObject postData = new JSONObject();
    postData.put("RoleName", RoleName);
    postData.put("Description", Description);
    postData.put("Enabled", Enabled);
    JSONArray rights = new JSONArray();
    for (String temp : Rights) {
      rights.put(temp);
    }
    postData.put("Rights", rights);

    return ops.POSTMethod(URI, postData.toString());
  } catch (JSONException e1) {
    e1.printStackTrace();
  }
  return "";
}

C# Code Example

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

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

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

    return ops.POSTMethod(URL, jsonRequestData);
  }

Output

WFRole object for the role that is added.

JSON Response Body Example

{
  "CreatedBy":"demo3\\administrator",
  "CreatedDate":"\/Date(1394324078561+0000)\/",
  "Description":"test",
  "Enabled":true,
  "LastModifiedBy":null,
  "LastModifiedDate":"\/Date(-62135568000000+0000)\/",
  "Name":"testasd12",
  "RightFlags":"NNNNNNNNNNNYNNYNNNNNNNNYNN
                NNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNNNNNN
                NNNNNNNNNNNNNNNNNNNNNN"
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher