Tags

This entity represents ticket and article tags in Autotask.

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: Tag

Entity Path:

/atservicesrest/v1.0/Tags

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.

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).

Field definitions

Field Name Datatype Read-Only Is Required Reference Name Picklist
createDateTime datetime      
id

long

 

 

isActive boolean        

isExcludedFromAutomaticTagging

boolean

 

 

 

 

isSystem

boolean

 

 

 

label

string (50)

 

 

 

lastModifiedDateTime

datetime

 

 

 

tagGroupID

integer

 

 

TagGroups

 

Additional resources