ResourceRoles
This query only entity describes Resources' associations to Department/ Role relationships, service desk queues, and service desk roles.. A resource must be assigned to at least one role. Resources are assigned to one or more roles through their department and can be assigned service desk roles. Resources can also be assigned to service desk queues.
NOTE An assigned role is no longer required for queue associations.
A role is required when a resource is assigned to a ticket or task. The role rate dictates the base rate for work the resource performs on that task or ticket.
The role associations described by this entity each have their own entities: ResourceRoleDepartment, ResourceRoleQueue, and ResourceServiceDeskRole. These entities can be queried, created, and updated via the API.
NOTE You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.
Entity details
Entity Name: | ResourceRoles |
Entity Path: |
/atservicesrest/v1.0/ResourceRoles |
Parent Entity: |
|
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
Conditions and requirements
- On query, only isActive ResourceRoles (isActive = True) are returned.
Role definitions
Role ID | Definition |
---|---|
110 | Time sheet approval |
112 | Expense approval |
Field definitions
The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:
- The entityInformation REST API call
- Making basic query calls to the REST API
- Advanced query features of the REST API
To learn how to query picklist endpoints, refer to Understanding picklists.
Notes
- For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
- LT indicates Local Term.
- If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
- You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name | Datatype | Read-Only | Is Required | Reference Name | Picklist |
---|---|---|---|---|---|
departmentID | long | Departments | |||
id | long | ||||
isActive | boolean | ||||
queueID | long | ||||
resourceID | long | Resources | |||
roleID | long | Roles |