ResourceRoleQueue

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

This entity now describes a Resource - Queue relationship.

IMPORTANT  Queue association no longer requires an associated Role, rendering this entities Active, Default, and Role fields obsolete. On Query, these fields will always return Null.

A new entity, ResourceServiceDeskRole, now describes the resource - service desk role association, which replaces the obsolete Queue - Role association. Refer to ResourceServiceDeskRole.

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.

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: ResourceRoleQueue
Can Create:
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

Conditions and requirements

  • Active, Default, and Role ID are now obsolete for this entity and on query will always return Null/blank This reflects changes to Autotask, introduced with the 2018.2 release, where resource association to a queue no longer requires a role assignment. The resource - service desk role association is described by the new ResourceServiceDeskRole entity.
  • ResourceID cannot be changed on update(). No error is returned; the new value is ignored.
  • There can be only 1 instance of ResourceRoleQueue.Default = True. On create() or update(), ResourceRoleQueue.Default can be set to True. If ResourceRoleQueue.Default = True already exists, the current instance is set to False and the new instance becomes the Default.
  • ResourceRoleQueue cannot be created with an inactive RoleID, ResourceID, or QueueID, but update is allowed. On update(), you cannot set ResourceID, RoleID, or QueueID to an inactive item.

Field definitions

The following table describes the standard Autotask field objects for this entity.

  • To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
  • For information on entity UDFs, use getUDFInfo().
  • For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.

For more information about fields marked as picklists, review our Understanding picklists article.

Field Name Label Datatype Read Only Is Required Reference Name Picklist
Active Active boolean      
Default Default boolean      
id ID Int64    
QueueID Queue ID integer    
ResourceID Resource ID integer Resource  
RoleID Role ID integer   Role