Update Role

API Type

Web Services

Description

Updates the description or access right selections of a role.

Syntax

public virtual WFRole UpdateRole(string RoleName, string Description, int[] Rights, bool Enabled)

Parameters

Name Description

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

Description
Function:
A description of an entity.
Type
string
Accepted Values:
A string that can contain spaces and special characters.

Rights
Function:
Specifies the rights that are assigned to the Role.
Type
WFAccessRights
Accepted 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
Function:
Enables or disables an entity.
Type
bool
Accepted Values:
  • True - Enables the entity.
  • False - Disables the entity.

Output

An updated WFRole object.

Example

IWFAdminService svc = GetAdminService();
string RoleName = ...// for example, "TestRole"
string Description = ...// for example, "This is new description for TestRole"
List<int> list = new List<int>();
list.Add(WFAccessRights.AddModifyGroup);
list.Add(WFAccessRights.AddModifyRole);
list.Add(WFAccessRights.AddModifyUser);
list.Add(WFAccessRights.AddProcessTemplate);
list.Add(WFAccessRights.AddRemoveModifyDelegation);
int[] Rights = list.ToArray();

try
	{
    WFRole updatedRole = svc.UpdateRole(RoleName, Description, Rights, true);
	}

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.