Get Role Entity
Gets a RoleEntity object.
NsApiSlow threshold: 2000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
The identifier of the RoleEntity object
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Response
OK
Carrier object for RoleEntity. Services for the RoleEntity Carrier is available from the User Agent.
Primary key
Visible role name
Description of the role.
The role type. Note that changing this field has no effect, so treat this as a read-only field.
Employee, ExternalUser, Anonymous, System 1 if role has been deleted (we do not actually delete)
Sorting rank of this role in lists
Registered when in UTC.
Apply role category membership to users
Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
Last updated when in UTC.
Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
Carrier object for DataRights. Services for the DataRights Carrier is available from the User Agent.
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Related topics
Get Role EntityNSUserAgentNSRoleEntityDefault Role EntityPost Role EntityPut Role Entity