TagGroups
This entity represents ticket tag groups 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: | TagGroup |
|
Entity Path: |
/atservicesrest/v1.0/TagGroups |
| 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
About this table| Field Name | Datatype | Read-Only | Is Required | Reference Name | Picklist |
|---|---|---|---|---|---|
| displayColor | integer |
|
|||
| id |
long |
|
|
|
|
| isActive | boolean | ||||
|
isSystem |
boolean |
|
|
|
|
|
label |
string (50) |
|
|
|
|
