Resources
About this entity
The Resource entity describes a person with a user account that provides general access to their organization's Autotask instance, based on the license type and security level they were assigned. Users with Administrator security level manage resources (users) in the Admin module of Autotask.
Refer to Managing internal resources and co-managing users.
Entity info
Can Create | Can Delete | Can Query | Can Update | Can have UDFs | Supports webhooks |
---|---|---|---|---|---|
false |
false |
true | true* | false |
true |
* The API user's security level must have admin access to Resources/Users (HR).
[n] represents the zone where your database is hosted. Refer to Querying user zone information via the REST API.
Description | URL |
---|---|
Full path | https://webservices[n].autotask.net/atservicesrest/v1.0/Resources |
Entity URLs |
Resources/entityInformation (GET) Resources/entityInformation/fields (GET) |
Parent Entity URLs |
Resources/query (GET, POST) Resources/{id} (GET) Resources/query/count (GET, POST) Resources (PUT, PATCH) Resources/entityInformation (GET) Resources/entityInformation/fields (GET)
|
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.
In the UI, most of these fields appear on the Resources, New Resource or Edit Resource pages. For field descriptions, refer to Adding, editing, or copying a resource.
Field Name | UI Label / Description | Datatype | Is Required | Read-Only | Reference Name | Picklist |
---|---|---|---|---|---|---|
accountingReferenceID |
Accounting Reference ID on the HR tab. An additional ID that links the resource to an external payroll or accounting application. |
string (100) | ||||
dateFormat |
Date Format on the General tab |
string (20) | ||||
defaultServiceDeskRoleID |
The ID of the default Service Desk Role on the Associations tab. This field cannot be queried. |
long | Roles | |||
Email Address Additional Email Address 1 Additional Email Address 2 on the General tab. If an unverified email is updated, the change takes place immediately. If a verified email is changed, a confirmation email is sent and the resource is prompted to confirm the change when they next log in.
|
string (254) | |||||
email2 | string (254) | |||||
email3 | string (254) | |||||
emailTypeCode |
Email Type on the General tab
|
string (20) | ||||
emailTypeCode2 | string (20) | |||||
emailTypeCode3 | string (20) | |||||
firstName |
First Name on the General tab |
string (50) | ||||
gender |
Gender on the General tab |
string (1) | ||||
greeting |
Prefix on the General tab |
integer | ||||
hireDate |
Hire Date on the HR tab |
datetime | ||||
homePhone |
Home Phone on the General tab |
string (25) | ||||
id |
The unique identifier of this entity. |
long | ||||
initials |
Payroll Identifier This field contains the same values as the payrollIdentifier field. During update if supplying a value for both fields, the value supplied for the payrollIdentifier will override the value supplied for the initials field. |
string (32) | ||||
internalCost |
Internal Cost (Burden Rate) on the HR tab The internalCost value is set to 0 if
|
decimal | ||||
isActive |
Active check box on the Security tab |
boolean | ||||
lastName |
Last Name on the General tab |
string (50) | ||||
licenseType |
The License Type associated with the selected security level. This value only appears on the Resources table in Admin. |
integer | ||||
locationID |
The location ID of the Primary Internal Location associated with the resource on the General tab |
integer | ||||
middleName |
Middle Initial on the General tab |
string (50) | ||||
mobilePhone |
Mobile Phone on the General tab |
string (25) | ||||
numberFormat |
Number Format on the General tab |
string (20) | ||||
officeExtension |
Extension on the General tab |
string (10) | ||||
officePhone |
Office Phone on the General tab |
string (25) | ||||
payrollIdentifier |
Payroll Identifier on the HRl tab. An ID that links the resource to an external payroll application. |
string (32) |
|
|
|
|
payrollType |
Payroll Type on the HR tab |
integer | ||||
resourceType |
Resource Type on the HR tab |
string (15) | ||||
suffix |
Suffix on the General tab |
integer | ||||
surveyResourceRating |
Resource Survey Rating on the Resources table. The average survey rating associated with the resource over a certain time span. |
decimal | ||||
timeFormat |
Time Format on the General tab |
string (20) | ||||
title |
Title on the General tab. This refers to the job title of the resource. |
string (50) | ||||
travelAvailabilityPct |
Travel Availability on the HR tab. This refers to the percent of weekly hours the resource is available for travel. |
string (15) | ||||
userName |
Username on the Security tab |
string (32) | ||||
userType |
Security Level on the Security tab |
integer |