Skip to main content
Create Default Role Entity From Type

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

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.

Body

Type

CreateDefaultRoleEntityFromType: Create a new role entity of the specified role type. The role type cannot be changed after the entity is created.

Type
enum<string>
Available options:
Employee,
ExternalUser,
Anonymous,
System

Response

OK

Carrier object for RoleEntity. Services for the RoleEntity Carrier is available from the User Agent.

RoleId
integer<int32>

Primary key

Name
string

Visible role name

Tooltip
string

Description of the role.

RoleType
enum<string>

The role type. Note that changing this field has no effect, so treat this as a read-only field.

Available options:
Employee,
ExternalUser,
Anonymous,
System
Deleted
integer<int32>

1 if role has been deleted (we do not actually delete)

Rank
integer<int32>

Sorting rank of this role in lists

Created
string<date-time>

Registered when in UTC.

UseCategories
integer<int32>

Apply role category membership to users

CreatedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Updated
string<date-time>

Last updated when in UTC.

UpdatedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

DataRights
object

Carrier object for DataRights. Services for the DataRights Carrier is available from the User Agent.

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.