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.
Entity URLs and relationships
- If this entity has a Parent relationship, you must perform all Create, Update, and Delete actions on the parent entity.
- If this entity is a child of a parent, you can leverage our Swagger instance to find the URLs you should use in your API calls. For more information, refer to Finding resource and child access URLs of REST API entities.
- To learn how to access Swagger, refer to Using Swagger UI to explore REST API requests.
| Parent | None |
| Children | ConfigurationItemCategoryUdfAssociations |
| URLs | ConfigurationItemCategories/query (GET, POST)
ConfigurationItemCategories/{id} (GET) ConfigurationItemCategories/query/count (GET, POST) ConfigurationItemCategories (PUT, POST, PATCH) ConfigurationItemCategories/entityInformation (GET) ConfigurationItemCategories/entityInformation/fields (GET) ConfigurationItemCategories/entityInformation/userDefinedFields (GET) |
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
About this table
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.
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 |
|---|---|---|---|---|---|
| displayColorRGB | integer |
|
|
||
| id | long |
|
|
||
| isActive | boolean |
|
|||
| isClientPortalDefault | boolean |
|
|||
| isGlobalDefault | boolean |
|
|||
| name | string (100) |
|
|||
| nickname | string (3) |
