InstalledProductCategory

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

This entity describes an asset category.

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: InstalledProductCategory
Can Create:
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

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.

Field definitions

The following table describes the standard Autotask field objects for this entity.

  • To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
  • For information on entity UDFs, use getUDFInfo().
  • For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.

For more information about fields marked as picklists, review our Understanding picklists article.

Field Name Label Datatype Read Only Is Required Reference Name Picklist
Active Active boolean      
ClientPortalDefault Client Portal Default boolean      
DisplayColorRGB Display Color RGB integer    
GlobalDefault Global Default boolean      
id Asset Category ID long    
Name Name string (100)      
Nickname Nickname string (3)