Query Role Members

API Type

Web Services

Description

Retrieves the members assigned to a role that match a specified WHERE clause of an SQL query expression.

Good to Know

  • Only pass the WHERE clause without WHERE keyword, not the whole query.

Syntax

public virtual WFRoleMember[] QueryRoleMembers(string roleName, string sqlWhereClause)

Parameters

Name Description

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

sqlWhereClause
Function:
The where clause of the SQL statement you want to query.
Type
string
Accepted Values:
The where clause of a SQL statement.

Output

Returns array of WFRoleMember members of the role that match the specified SQL statement.

Example

IWFAdminService svc = GetAdminService();
string roleName = ...// for examples, "Users"
string sqlWhereClause = ...// for example, "ASSIGNEE_TYPE='User'"

try
	{
    WFRoleMember[] roleMembers = svc.QueryRoleMembers(roleName, sqlWhereClause);
    foreach (WFRoleMember member in roleMembers)
        {
        Console.WriteLine("Assignee = '{0}', Created Date = '{1}'",
                       member.Assignee,
                       member.CreatedDate.ToShortDateString());
        }
	}

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

/*
This example produces the following results:
Assignee = 'DEMO\CONTROLLER' & Created Date = '9/18/2009'
Assignee = 'DEMO\CFO' & Created Date = '9/18/2009'
*/

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.