TagGroup

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 represents ticket tag groups in Autotask.

Entity details

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

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

Conditions and requirements

General

  • To perform Create actions, your API user must have the Can administer ticket tags and tag groups permission.

  • To perform Update and Delete actions, your API user must have the corresponding Service Desk (Tickets) administrator permissions and the Can administer ticket tags and tag groups permission.

  • Each group label must be unique.

  • System tag groups cannot be deleted.

  • System tag groups cannot have their labels updated.

  • System tag groups can have their active status and display color updated.

  • When a non-System tag group is deleted, the API will leave its tags in place. You will need to separately disable or delete the tags from the group.

Special field attributes

Field Conditions and Requirements
DisplayColor Not required; will default to 19 when a value is not supplied during Create

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
DisplayColor

Display Color

 integer      
id

ID

long

 

 
IsActive

Is Active

 boolean        

IsSystem

Is System

boolean

 

 

 

Label

Label

string (50)