TicketCategory

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 a ticket category applied to tickets in Autotask to specify features and fields that appear on the ticket detail.

In Autotask, you can create ticket categories that are identified as API-Only. Such ticket categories are hidden everywhere you select a ticket category when you create or edit a ticket; they are only used when tickets are created via the API. Refer to API-only Ticket Categories.

Entity details

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

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

Conditions and requirements

General

The RMA ticket category cannot be edited through the API

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      
ApiOnly API Only boolean        
DisplayColorRGB Display Color RGB integer    
GlobalDefault Global Default boolean      
id Ticket Category ID Int64    
Name Name string (30)      
Nickname Nickname string (3)