Tag

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 and article tags in Autotask.

Entity details

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

Entity Name: Tag
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.

  • Tag labels must be unique.

  • System tags may not be deleted.

  • System tags may not have their label updated.

  • System tags may have the tag group, active status, and "excluded from automatic tagging" status changed.

  • Non-system tags may be deleted; tags will prune from the tickets with which they are associated.

  • The API may not create more than the maximum number of non-system tags (25,000).

Special field attributes

Field Name Label Datatype Read-Only Is Required Reference Name Picklist
CreateDateTime

Create Date Time

 datetime      
id

ID

long

 

 
IsActive

Is Active

 boolean        

IsExcludedFromAutomaticTagging

Is Excluded From Automatic Tagging

boolean

 

 

 

 

IsSystem

Is System

boolean

 

 

 

Label

Label

string (50)

 

 

 

LastModifiedDateTime

Last Modified Date Time

datetime

 

 

 

TagGroupID

Tag Group ID

integer

 

 

TagGroup

 

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)