Selectable Fields for Role

This section lists the selectable fields for roles.

Selectable Fields for Role

Field Description Output

admin

?

Not enabled

assignment[].*

Person and role objects

Lists all assignments to persons and roles

ancestor[].*

Ancestor users

Without any "." or [], returns a list of all ancestors of the current role. With [], returns TRUE/FALSE, depending on whether any ancestor matches the condition in [].

If the string in brackets has a bar character, the text before the bar is a a pattern and the text after the bar is an expression that acts as a where-clause. If there is no bar, the entire string becomes the pattern.

child.*

Subrole object

Name of child role

description

?

Value

email

?

Value

hidden

Is this role defined as hidden?

True/False

id

The role identifier

Value

isagroup

Is a group?

True/False

isanorg

Is an organization?

True/False

isaperson

Is a person?

True/False

isaproject

Is a project?

True/False

isarole

Is a role?

True/False

mask

The list of accesses

Defaults to accesses of person

modified

The time and date the administration object was modified

Value

modified.generic

The time and date in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator) the administration object was modified

Value

name

The role name

Value

object[ ]

a corresponding business object

Returns a business object where the type matches the string in [ ] and the name is the same as the role's name. If no string is given, the object type is role, with case ignored. In a case sensitive environment if more than 1 type meets that criteria (such as both a Person type and a PERSON type), OR if there are more than 1 object with the same type and name that are not in the same revision chain, the object with the latest originated date is returned. When objects with same type and name are in the same revision chain, the latest revision is returned.

org[]'*

The immediate parent of the role defined as a project

Without any "." or [], returns a list of all parents of the current role defined as an organization. With [], returns TRUE/FALSE, depending on whether any parent matches the condition in [].

If the string in brackets has a bar character, the text before the bar is a a pattern and the text after the bar is an expression that acts as a where-clause. If there is no bar, the entire string becomes the pattern.

originated

The time and date the administration object was created

Value

originated.generic

The time and date in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator) the administration object was created

Value

parent[].*

Parents of the role and group

Without any "." or [], returns a list of all parents. With [], returns TRUE/FALSE, depending on whether any parent matches the condition in [].

If the string in brackets has a bar character, the text before the bar is a a pattern and the text after the bar is an expression that acts as a where-clause. If there is no bar, the entire string becomes the pattern.

person.*

The person(s) in the role

Name(s) of person(s) (see Selectable Fields for Person)

project[].*

The immediate parent of the role defined as a project

Without any "." or [], returns a list of all parents of the current role defined as a project. With [], returns TRUE/FALSE, depending on whether any parent matches the condition in [].

If the string in brackets has a bar character, the text before the bar is a a pattern and the text after the bar is an expression that acts as a where-clause. If there is no bar, the entire string becomes the pattern.

property[].*

The associated properties

If property[ ] is specified, returns property names and values. If blank, returns all property names and values.

role[].*

The immediate parent of the role

Without any "." or [], returns a list of all parents of the current role. With [], returns TRUE/FALSE, depending on whether any parent matches the condition in [].

If the string in brackets has a bar character, the text before the bar is a a pattern and the text after the bar is an expression that acts as a where-clause. If there is no bar, the entire string becomes the pattern.