System APIs
Creates a new role template
| HTTP method | POST |
| URI | https://api.rambase.net/system/role-templates |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 6494, version 3 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
Name
Required/mandatory field
Name of the role
>{String}</Name>RequiredUserLevel
The user level required to have this role. Only user having the same level or higher can be assigned.
This field also controls which duties can be added to the role. Only duties with the same level or lower can be added.
User levels (highest level first): Administrator, Partner, User, Portal user
Applicable domain values can be found here
Minimum value: 200
This field is optional.
>{Integer}</RequiredUserLevel>Name
Required/mandatory field
Name of the role
": "{String}",RequiredUserLevel
The user level required to have this role. Only user having the same level or higher can be assigned.
This field also controls which duties can be added to the role. Only duties with the same level or lower can be added.
User levels (highest level first): Administrator, Partner, User, Portal user
Applicable domain values can be found here
Minimum value: 200
This field is optional.
": "{Integer}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
RoleTemplateId
Role template identifier
>{Integer}</RoleTemplateId>Name
Name of the role
>{String}</Name>Description
Description of the role
>{String}</Description>Type
Role by company level (DB) or organizational unit (ORG)
Possible domain values can be found here
>{Integer}</Type>RequiredUserLevel
The user level required to have this role. Only user having the same level or higher can be assigned.
This field also controls which duties can be added to the role. Only duties with the same level or lower can be added.
User levels (highest level first): Administrator, Partner, User, Portal user
Possible domain values can be found here
>ModuleId
Module identifier
>{Integer}</ModuleId>Name
Name of the module
>{String}</Name>ModuleLink
Module reference
>{String}</ModuleLink>IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
>{Boolean}</IsChanged>ChangedBy
EmployeeId of the employee making the change
>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>IsPendingDeployment
Tells whether this object has been changed locally and is ready to be deployed from the Repository
>{Boolean}</IsPendingDeployment>RoleTemplateId
Role template identifier
": "{Integer}",Status
Status of the role
Possible domain values can be found here
": "{Integer}",Name
Name of the role
": "{String}",Description
Description of the role
": "{String}",Type
Role by company level (DB) or organizational unit (ORG)
Possible domain values can be found here
": "{Integer}",RequiredUserLevel
The user level required to have this role. Only user having the same level or higher can be assigned.
This field also controls which duties can be added to the role. Only duties with the same level or lower can be added.
User levels (highest level first): Administrator, Partner, User, Portal user
Possible domain values can be found here
": {ModuleId
Module identifier
": "{Integer}",Name
Name of the module
": "{String}",ModuleLink
Module reference
": "{String}",Scope
Scope of the Role
Possible domain values can be found here
": "{String}",IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
": "{Boolean}",ChangedBy
EmployeeId of the employee making the change
": {UserId
User identifier
": "{Integer}",UserLink
User reference
": "{String}"IsPendingDeployment
Tells whether this object has been changed locally and is ready to be deployed from the Repository
": "{Boolean}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 100138 HTTP 400 | Only the operators NE and EQ can be used on Values containing a comma list or wildcards ( ?, * ) |
| Error 102063 HTTP 400 | Wildcard compare does not support both ? and * |
| Error 102064 HTTP 400 | Wildcard compare does not support more than two asterisks (*) |
| Error 109050 HTTP 400 | Role template name is required |
| Error 109048 HTTP 400 | Role template with name {0} already exists |
| Error 109051 HTTP 403 | The role template has duties with user level that is not allowed for the new user level specified on the role |