taggroup

Tag groups collect tags together, allowing the management of devices across multiple tags. The taggroup command manages the groups.

Command Type	DisplayNet
Minimum Version	3.6.x

Usage

taggroup list
taggroup add <group_name>
taggroup addtag <group_name> <tag_name>
taggroup removetag <group_name> <tag_name>
taggroup rename <old_group_name> <new_group_name>
taggroup delete <group_name>

Subcommands

Subcommand	Description
list	Returns all tag groups in the system
add	Creates a tag group
addtag	Adds a tag to an existing group
removetag	Removes a tag from a group
rename	Renames a tag group
delete	Deletes a tag group

Arguments

Argument	Required	Description
group_name	All except list	A valid tag group name. Spaces are not supported.
tag_name	addtag, removetag	The name of an existing tag. Manage tags with tag.

Examples

Create a group and populate it
taggroup add boardroom
taggroup addtag boardroom boardroom_sources
taggroup addtag boardroom boardroom_displays

Return value

taggroup list

taggroup list
{
  "status": "SUCCESS",
  "request_id": null,
  "result": {
    "taggroups": [
      {
        "TagGroupItemId": 3,
        "GroupName": "group_name_1",
        "tags": [
          "tag_1",
          "tag_b",
          "tag_3"
        ]
      },
      {
        "TagGroupItemId": 13,
        "GroupName": "group_name_2",
        "tags": [
          "tag_a",
          "tag_b",
          "tag_1"
        ]
      }
    ]
  },
  "error": null
}

Other subcommands

taggroup delete group_name
{
  "status": "SUCCESS",
  "request_id": null,
  "result": null,
  "error": null
}

Notifications

Group changes broadcast a DN_NOTIFICATION with taggroup_add, taggroup_update, taggroup_rename, or taggroup_delete results:

add

taggroup add newGroup123
{
  "status": "DN_NOTIFICATION",
  "request_id": null,
  "result": {
    "taggroup_add": [
      {
        "TagGroupItemId": 25,
        "GroupName": "newGroup123",
        "tags": []
      }
    ]
  },
  "error": null
}

addtag / removetag

taggroup addtag newGroup123 testing
{
  "status": "DN_NOTIFICATION",
  "request_id": null,
  "result": {
    "taggroup_update": [
      {
        "TagGroupItemId": 25,
        "GroupName": "newGroup123",
        "tags": [
          "testing"
        ]
      }
    ]
  },
  "error": null
}

rename

taggroup rename old_group_name new_group_name
{
  "status": "DN_NOTIFICATION",
  "request_id": null,
  "result": {
    "taggroup_rename": [
      {
        "TagGroupItemId": 23,
        "GroupName": "old_group_name",
        "NewName": "new_group_name"
      }
    ]
  },
  "error": null
}

REST API

Endpoint type	DisplayNet API command
Address	POST /api/displaynet/<operation>, or name the operation in the body of a POST /api/displaynet. See Sending commands.
Role	User

Subcommand	Operation	Parameters
add	taggroup_add	name
addtag	taggroup_addtag	group tag
delete	taggroup_delete	name
list	taggroup_list	—
removetag	taggroup_removetag	group tag
rename	taggroup_rename	name new_name

See also

• tag: create, rename, and delete tags
• devicetag: assign tags to devices, walls, multiviews, and presets