Add Role Member

API Type

Web Services

Description

Adds a user or group to the specified role.

Good to Know

  • This user or group inherits the access right specified at the role level.

Syntax

public virtual WFRoleMember AddRoleMember(string RoleName, string Assignee, string AssigneeType, string ClientData, string ObjectID, string ObjectType);

Parameters

Name Description

RoleName
Function:
The name of a role.
Type
string
Accepted Values:
A valid role name.

Assignee
Function:
The name of the assignee.
Type
string
Accepted Values:
A valid user name or group name, depending upon the assignee type.

AssigneeType
Function:
The type for the assignee for the task.
Type
string
Accepted Values:
  • User - Assigns the task to a user.
  • Group - Assigns the task to a group.

ClientData
Function:
Specifies the client data, which identifies a client for AgilePoint Server.
Type
string
Accepted 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
Function:
Reserved for future use.
Type
string
Accepted Values:
A null value.

ObjectType
Function:
Reserved for future use.
Type
string
Accepted Values:
A null value.

Output

WFRoleMember object.

Example

IWFAdminService svc = GetAdminService();                              

string RoleName = "Administrative";
string Assignee = @"Demo3\Administrator";
string AssigneeType = "User";

try
    {
    WFRoleMember member = svc.AddRoleMember(RoleName, Assignee,
    AssigneeType, "", null, null);
    }

catch (Exception ex)
    {
    Console.WriteLine("Failed! " + ShUtil.GetSoapMessage(ex));
    }

Supported Versions

3.2.0.4 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.