Add Role Member

API Type

REST

HTTP Method

POST

Description

Adds a user or a group to a role.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
Assignee	Definition: The name of the assignee. Type string Allowed Values: A valid user name or group name, depending upon the assignee type.
AssigneeType	Definition: The type for the assignee for the task. Type string Allowed Values: User - Assigns the task to a user. Group - Assigns the task to a group.
ClientData	Definition: Specifies the client data, which identifies a client for AgilePoint Server. Type string Allowed Values: A string that contains the client data. If this value is null, the system will keep existing client data. Otherwise the relevant data is overwritten.
ObjectID	Definition: Reserved for future use. Type string Allowed Values: A null value.
ObjectType	Definition: Reserved for future use. Type string Allowed Values: A null value.
RoleName	Definition: The name of a role. Type string Allowed Values: A valid role name.

These properties are based on the class AddRoleMemberHelper

JavaScript Code Example

$("#btnAddRoleMember").click(function () {
  
  var JSONObject = { 
    RoleName: "Administrators", Assignee: "DEMO3\HR", 
    AssigneeType: "User", 
    ClientData: null, ObjectID: "00000000000000000000000000000000", 
    ObjectType: "All"
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/AddRoleMember",
    data: JSON.stringify(JSONObject)
  });
  
});

Java Code Example

public String AddRoleMember() {

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

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

  
    JSONObject postData = new JSONObject();
    postData.put("RoleName", "Regional Managers");
    postData.put("Assignee", "DEMO3\\HR");
    postData.put("AssigneeType", "User");
    postData.put("ClientData", "");
    postData.put("ObjectID", "00000000000000000000000000000000");
    postData.put("ObjectType", "All");

    return ops.POSTMethod(URI, postData.toString());
  return "";
}

C# Code Example

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

    string jsonRequestData = "{
      \"RoleName\":\"" + "Administrators" + "\",
      \"Assignee\":\"" + "demo3\\\\brian.lucas" + "\",
      \"AssigneeType\":\"" + "User" + "\",
      \"clientData\":\"" + null + "\",
      \"ObjectID\":\"" + "00000000000000000000000000000000" + "\",
      \"ObjectType\":\"" + "All" + "\"}"

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

    return ops.POSTMethod(URL, jsonRequestData);
  }

Output

WFRoleMember object.

JSON Response Body Example

{
  "Assignee": "DEMO3\HR"
  "AssigneeType": "User"
  "ClientData": null
  "CreatedBy": "demo3\\brian.lucas"
  "CreatedDate":" \/Date(928149600000)\/", 
  "ObjectID": "00000000000000000000000000000000"
  "ObjectName": null
  "ObjectType": "All"
  "RoleName": "Administrators"
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher

Parent topic: Group, Role, and Rights

Quick Links:

Documentation Library

AgilePoint

AgilePoint BPMS v5.0 R2 SP1 for .NET 3.5, .NET 4.0, and Genesis Edition

AgilePoint BPMS v5.0 SP3 for Universal Edition and Azure