ConfigurationItemCategories

This entity describes an 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: ConfigurationItemCategories

Entity Path:

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

IMPORTANT  Requests to this entity require special handling. Refer to the Entity URLs and relationships section of this article for details.

Conditions and requirements

General

  • You are limited to 200 active asset categories. Attempting to create an asset category as active or update an existing inactive asset category to active will fail if you cross this limit.

  • When you create an asset category via the API, it will match the field, section, and insight configuration of the asset category that you are copying. All field default values will also copy. If the API receives a non-zero value for the id field during a create, it will copy the asset category associated to that id. Otherwise, it will copy the default asset category in your system.

Special field attributes

Field Conditions and Requirements
displayColorRGB Asset categories have colored badges. The color is selected when the category is created or edited. The integers on the picklist represent the available colors. There is no impact other than the selection of the badge color.
id During create, a value is required for this field. It cannot be left blank or equal 0. You must instead supply the id of an existing ConfigurationItemCategory which will be copied to create this new ConfigurationItemCategory.

Field definitions

Field Name Datatype Read-Only Is Required Reference Name Picklist
displayColorRGB integer    
id long    
isActive boolean      
isClientPortalDefault boolean      
isGlobalDefault boolean      
name string (100)      
nickname string (3)        

Additional resources