ConfigurationItems

About this entity

This entity describes Autotask devices (previously known as assets or configuration items). Devices are products that are associated with an organization. Autotask users manage devices through the CRM Module (CRM > Devices, or on the Devices tab of the Organization page).

Any hardware or software item that is sold, installed, tracked, updated, and managed by an MSP can be a device tracked in Autotask. While they can be created manually, they are typically added to the Autotask instance through an integration with an external application, and synced to Autotask.

Because there are so many different kinds of devices, this entity supports up to 500 user-defined fields. Refer to UserDefinedFieldDefinitions.

Some UDFs require special field-level security to access, called Protected Data Permissions.

  • If the user doesn't have Protected Data Permissions, no UDFs will be displayed. Otherwise all UDFs are displayed, but their values are masked based on the user's PDPs.
  • Users who don't have the PDPs to see the actual UDF value will see a "*****" mask, whether the UDF has a value or not.
  • An error is thrown if user attempts to update a UDF outside their permissions.

A version is a set of changes to an existing device that was saved at the same time.

  • The API will always return the most recent version of a device.
  • Updates to a device via the API will create a new version from the perspective of the Autotask UI.
  • Neither version history nor rollback functionality are available via the API.

Entity info

Can Create Can Delete Can Query Can Update Can have UDFs

true

false

 true true true

IMPORTANT  In the English Autotask UI, customers can select the term they want to use for the ConfigurationItems entity. The default term is Device. It may also appear in the UI as Asset, Configuration Item, Installed Asset, or Installed Product. Refer to Terminology differences between the Autotask UI and the API.

Parent Children
None

ConfigurationItemAttachments

ConfigurationItemBillingProductAssociations

ConfigurationItemDnsRecords

ConfigurationItemNotes

ConfigurationItemRelatedItems

ConfigurationItemSslSubjectAlternativeName

[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/ConfigurationItems
Entity URLs

ConfigurationItems/entityInformation (GET)

ConfigurationItems/entityInformation/fields (GET)

ConfigurationItems/entityInformation​/userDefinedFields (GET)

ConfigurationItems/{id} (GET)

ConfigurationItems​/query (GET, POST)

ConfigurationItems​/query​/count (GET, POST)

ConfigurationItems (PUT, POST, PATCH)

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:

To learn how to query picklist endpoints, refer to Understanding picklists.

IMPORTANT  When the API receives a request to update a field that contains Rich Text, the API will update the text-only version of the field and overwrite the data in the Rich Text field with plain text. All text formatting and images will be lost. Refer to The Rich Text editor to learn more.

In the UI, most of these fields appear on the New Device or Edit Device pages. The fields that are displayed are determined by the device category selected for the device. For field descriptions, refer to Adding and editing devices.

Field Name UI Label / Description Datatype Is Required Read-Only Reference Name Picklist
apiVendorID

The Tracking Identifier of the integration vendor that synced the device to Autotask.

integer    
companyID

References the Organization that owns the device on the Detail panel. companyID cannot be updated. Any companyID value provided on update is ignored.

 integer Companies  
companylocationID References the Location on the Details panel. integer     CompanyLocations  

configurationItemCategoryID

References the Device Category on the Main panel.

If the API does not receive a value for configurationItemCategoryID during Create, the default device category will be assigned.

  • The default values for all fields stored on the utilized device category will be applied.
  • If the user specifies a value for a field that is also defaulted by the device category, the user's specified value will be used.
  • All fields will be available on the configurationItem entity regardless of their visibility settings on the device category.
  • The "required" status and available list value settings for fields stored on the device's device category will NOT be respected when creating or editing devices in the API.
  • The system categories Domain and SSL Certificate are not displayed in the API.

integer

 

 

ConfigurationItemCategories

 

configurationItemType

Device Type.

Before Autotask introduced device categories, the main function of device types was the selection of the correct user-defined fields for a product and the devices based on it. This function has been transferred to device categories. We are maintaining this field for legacy integrations.

integer

 

 

 

contactID

References the Contact on the Details panel. The contact must be:

  • associated with the company referenced by the companyID or its parent company
  • an active contact on Create and Update, although no error is thrown if the already associated contact was set to inactive
 integer     Contacts  
contractID

References the Contract on the Detail panel. The associated contract can be inactive.

If the contract is associated with a Service Level Agreement (serviceLevelAgreementID), the Contract Service Level Agreement will not automatically be associated with the serviceLevelAgreementID, even if configurationItem does not have an associated Service Level Agreement.

 integer     Contracts  
contractServiceBundleID

References the Service or Bundle on the Details panel.

You can either supply info for the service (serviceID or contractServiceID) or the bundle (serviceBundleID or contractServiceBundleID) but not both.

 integer     ContractServiceBundles  

contractServiceID

integer

 

 

ContractServices

 

createDate

The Created date on the Main panel.

The date the device was created in Autotask or in the syncing integration.

datetime

 

 

 
createdByPersonID

References the creator on the Main panel. The unique identifier of the contact or resource who created the device.

 integer   Resources  
dailyCost The Daily Cost on the Details panel. decimal        
dattoAvailableKilobytes

The fields starting with "datto" are fields that are synced from Datto BCDR.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 long      
dattoDeviceMemoryMegabytes integer      
dattoDrivesErrors boolean      
dattoHostname string (255)      
dattoInternalIP string (255)      
dattoKernelVersionID integer    
dattoLastCheckInDateTime datetime      
dattoNICSpeedKilobitsPerSecond integer      
dattoNumberOfAgents integer      
dattoNumberOfDrives integer      
dattoNumberOfVolumes integer      
dattoOffsiteUsedBytes long      
dattoOSVersionID integer    
dattoPercentageUsed decimal      
dattoProtectedKilobytes long      
dattoRemoteIP string (255)      
dattoSerialNumber string (100)      
dattoUptimeSeconds integer      
dattoUsedKilobytes long      
dattoZFSVersionID integer    
deviceNetworkingID string (100)      

domain

The Domain field on the Main panel when the category is Domain.

To successfully create and store a domain name for a device, the domain value must adhere to the requirements described in our Creating and updating a Domain device > Populating the Domain field article.

string (255)

 

 

 

 

domainExpirationDateTime

Expiration Date and Expiration Time fields on the Details panel when the category is Domain.

datetime

 

 

 

 

domainLastUpdatedDateTime

Last Updated Date and Last Updated Time fields on the Details panel when the category is Domain.

datetime

 

 

 

 

domainRegistrarID

References the Registrar of the domain on the Details panel when the category is Domain.

integer

 

 

DomainRegistrars

 

domainRegistrationDateTime

Registration Date and RegistrationTime fields on the Details panel when the category is Domain.

datetime

 

 

 

 
hourlyCost

The Hourly Cost on the Details panel.

decimal        
id

The unique identifier of this entity.

 long    
impersonatorCreatorResourceID

The resource ID of the API user who impersonated the resource who created the device.

 integer   Resources

 
installDate

The Install Date on the Details panel.

datetime        
installedByContactID

The unique identifier of the Client Portal user who created the device.

 integer   Contacts  
installedByID

References the resource that populates the Installed By field on the Details panel.

integer   Resources  
isActive

Status on the Details panel. True if the status of the device is active.

 boolean      
lastActivityPersonID

References the resource who performed the last activity on the device.

 integer   Resources  
lastActivityPersonType

Indicates whether the last activity was performed by a resource or a contact. This field cannot be queried.

 integer    
lastModifiedTime

The Date field on the Tools > Device History page.

 datetime      
location

The Area field on the Details panel.

string (100)        
monthlyCost

The Monthly Cost on the Details panel.

decimal        
notes

The Description field on the Main panel.

string (5000)        
numberOfUsers

The Number of Users field on the Details panel.

decimal        
parentConfigurationItemID

References the Parent Device on the Details panel.

A device can have a two-level dependency with another device, called a parent-child relationship. For example, a desktop computer might be a parent to a printer, scanner, and monitors. There are no billing implications for this relationship.

 integer     ConfigurationItems  
perUseCost

The Per-Use Cost on the Details panel.

decimal        
productID

References the Product field on the Main panel.

If the configuration item was sourced from an InventoryStockedItems entity, its product ID will be tied to the product ID of the inventory item and cannot be changed via the API. You can tell if a configuration item is associated with an inventoryStockItem by querying the inventoryStockItem.configurationItemID field.

 integer   Products  
referenceNumber

The Reference Number on the Details panel.

Reference numbers work like serial numbers, but you can assign them by using your own system. Reference numbers are not required by product categories.

 string (100)        
referenceTitle

The Reference Name on the Details panel.

string (200)        
rmmDeviceAuditAntivirusStatusID

All fields that begin with "rmm" track data collected by the Datto RMM integration. All RMM fields are read-only.

 

The rmmDeviceAuditOperatingSystem field cannot be queried.

 

 

 

 

 

 

 

 

 integer    
rmmDeviceAuditArchitectureID integer    
rmmDeviceAuditBackupStatusID integer    
rmmDeviceAuditDescription string (255)      
rmmDeviceAuditDeviceTypeID integer    
rmmDeviceAuditDisplayAdaptorID integer    
rmmDeviceAuditDomainID integer    
rmmDeviceAuditExternalIPAddress string (255)      
rmmDeviceAuditHostname string (255)      
rmmDeviceAuditIPAddress string (255)      
rmmDeviceAuditLastUser string (50)      
rmmDeviceAuditMacAddress string (255)      
rmmDeviceAuditManufacturerID integer    
rmmDeviceAuditMemoryBytes long      
rmmDeviceAuditMissingPatchCount integer      
rmmDeviceAuditMobileNetworkOperatorID integer    
rmmDeviceAuditMobileNumber string (255)      
rmmDeviceAuditModelID integer    
rmmDeviceAuditMotherboardID integer    
rmmDeviceAuditOperatingSystem string (255)      
rmmDeviceAuditPatchStatusID integer    
rmmDeviceAuditProcessorID integer    
rmmDeviceAuditServicePackID integer    
rmmDeviceAuditSNMPContact string (255)      
rmmDeviceAuditSNMPLocation string (255)      
rmmDeviceAuditSNMPName string (255)      
rmmDeviceAuditSoftwareStatusID integer    
rmmDeviceAuditStorageBytes long      
rmmDeviceID

 

 long      
rmmDeviceUID

 

 string (255)      
rmmOpenAlertCount

 

 integer      
serialNumber

The Serial Number on the Details panel.

If the configuration item was sourced from an InventoryStockedItems entity, the serial number will come from the inventoryStockedItem. If the serial number is updated via the API, the serial number for the related inventoryStockedItem will also be updated.

 string (100)        
serviceBundleID

The Service or Bundle on the Details panel.

The contract service or service bundle associated with the device for billing purposes.

 

 integer     ServiceBundles  
serviceID integer     Services  
serviceLevelAgreementID

The Service Level Agreement assigned to the device on the Details panel.

 integer      
setupFee

The setup fee of the contract associated with the device.

 decimal        
sourceChargeID The ID of the associated charge item (TicketCharge, ProjectCharge, ContractCharge, QuoteItem). This field is empty for devices that were not created from a charge or quote item. integer      
sourceChargeType

The possible options are: Ticket Cost, Project Cost, Contract Cost, and Quote Item. This field is empty for devices that were not created from a charge or quote item.

integer    

sslCommonName

 These fields appear on the SSL certificate linked to the device in the Related Devices section of the Main panel. They cannot be edited manually, only via update by the certificate authority.

string (255)

 

 

 

sslIssuedBy

string (255)

 

 

 

sslLocation

string (255)

 

 

 

sslOrganization

string (255)

 

 

 

sslOrganizationUnit

string (255)

 

 

 

sslSerialNumber

string (100)

 

 

 

sslSignatureAlgorithm

string (255)

 

 

 

sslSource

string (32000)

 

 

 

 

sslValidFromDateTime

datetime

 

 

 

sslValidUntilDateTime

datetime

 

 

 
vendorID

References the organization ID of the Vendor on the Details panel.

 integer     Companies  
warrantyExpirationDate

The Warranty Expiration Date on the Details panel.

 datetime        

Additional resources