CompanySiteConfigurations

The CompanySiteConfigurations entity takes on the UDFs that hold the site setup information for the account represented by companyID.

Do not confuse CompanySiteConfigurations with InternalLocations, the entity that describes the locations associated with Autotask resources.

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: CompanySiteConfigurations

Entity Path:

/atservicesrest/v1.0/CompanySiteConfigurations
Parent Entity: CompanySiteConfigurations
Can Create:  
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:

Conditions and requirements

NOTE  Site Configuration UDFs are associated with the CompanySiteConfiguration entity. In Autotask, required Site Configuration UDFs are required for Customer type accounts only. The REST API, however, will show all Site Configuration UDFs for all Company Locations as not required until an Update is performed. When you perform an Update, the Web Service API will perform a check and, for Company Locations where Company.Type = Customer, any required Site Configuration UDF will be required. If no data is provided for a required UDF, Web Services cannot complete the update.

IMPORTANT  The API respects Data Protection Permissions (DPP's) for CompanySiteConfiguration Site Configuration user-defined fields. See details below.

  • The CompanySiteConfiguration entity can have no more than 500 UDFs. Refer to UserDefinedFieldDefinitions.
  • Administrators assign Protected Data Permissions from > Admin > Features & Settings > Resources/Users (HR) > Security > Protected Data Permission.
  • If the user has no Protected Data Permission, then no UDFs will display. Otherwise all UDFs are displayed, but their values are masked based on the user's PDPs.
    User sees a "*****" mask when the user does not have the PDPs to see the actual UDF value, whether the UDF has a value or not.
  • Users without PDP's cannot Query or Update this entity. An error is thrown if user attempts to update a UDF outside their permissions.
  • companyID, id, and locationName are Read-Only; therefore, update is allowed only when the entity has user-defined fields that allow update and the correct PDP's to access UDF data.

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.

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
companyID integer Companies  
id long    
locationName string (100)      

Additional resources