ConfigurationItemCategoryUdfAssociations

This entity represents the relationship between an asset category and a specific UDF. One of these entities exists for every UDF that is set as visible on each asset category.

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

Entity Path:

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

Conditions and requirements

General

  • This entity does not control the sort order of its UDF.

  • Query will return only ConfigurationItemCategory/UDF associations that are visible (not hidden).

  • When an ConfigurationItemCategoryUdfAssociation is created via the API, the UDF it represents will be placed as the last field in the last section of the asset category's field layout.

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
configurationItemCategoryID integer ConfigurationItemCategories  
id long    
isRequired boolean      
userDefinedFieldDefinitionID integer UserDefinedFieldDefinitions  

Additional resources