Remove Role Member

API Type

REST

HTTP Method

POST

Description

Removes a user or a group from a specified role.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

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.
ObjectID	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 RemoveRoleMemberHelper

JavaScript Code Example

$("#btnRemoveRoleMember").click(function () {
  
  var JSONObject = { 
    RoleName: "Administrators", Assignee: "demo3\\brian.lucas", 
    AssigneeType: "User", 
    ObjectID: "00000000000000000000000000000000"
    };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/RemoveRoleMember",
    data: JSON.stringify(JSONObject)
  });
  
});

Java Code Example

public String RemoveRoleMember(String RoleName, String Assignee,
  String AssigneeType, String ObjectID) {

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

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

  JSONObject postData = new JSONObject();
  try {
    postData.put("RoleName", RoleName);
    postData.put("Assignee", Assignee);
    postData.put("AssigneeType", AssigneeType);
    postData.put("ObjectID", ObjectID);
    return ops.POSTMethod(URI, postData.toString());
  } catch (JSONException e1) {
    e1.printStackTrace();
  }
  return "";
}

C# Code Example

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

    string jsonRequestData = "{
      \"RoleName\":\"" + "Administrators" + "\",
      \"Assignee\":\"" + data + "\",
      \"AssigneeType\":\"" + "User" + "\",
      \"ObjectID\":\"" + "00000000000000000000000000000000" + "\"}";

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

    return ops.POSTMethod(URL,jsonRequestData);
  }

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint BPMS v5.0 R2 and higher