tag

Tagging organizes devices and objects to simplify routing and manage large DisplayNet systems. The tag command manages the tags themselves; to assign tags to devices and objects, see devicetag.

Command Type	DisplayNet
Minimum Version	3.6.x

Usage

tag list
tag add <tag_name>
tag rename <old_tag_name> <new_tag_name>
tag delete <tag_name>
tag forcedelete <tag_name>

Subcommands

Subcommand	Description
list	Returns all tags in the DisplayNet system
add	Adds a new tag
rename	Renames a tag
delete	Deletes a tag. Returns an error if the tag is still assigned to at least one device or group
forcedelete	Deletes a tag and removes it from all devices and groups

Arguments

Argument	Required	Description
tag_name	Yes	A valid tag name. Spaces are not supported. Use underscores or CamelCase instead.

Examples

Create and rename a tag
tag add conference_sources
tag rename conference_sources boardroom_sources

Delete a tag that is still in use
tag forcedelete boardroom_sources

Return value

tag list

tag list
{
  "status": "SUCCESS",
  "request_id": null,
  "result": {
    "tags": [
      {
        "TagItemId": 3,
        "TagName": "tagName1"
      },
      {
        "TagItemId": 1,
        "TagName": "this_is_a_long_tag_name_with_underscores"
      }
    ]
  },
  "error": null
}

Other subcommands

tag delete testing123
{
  "status": "SUCCESS",
  "request_id": null,
  "result": null,
  "error": null
}

Notifications

Tag changes broadcast a DN_NOTIFICATION with tag_new, tag_rename, or tag_delete results:

add

tag add newTagName123
{
  "status": "DN_NOTIFICATION",
  "request_id": null,
  "result": {
    "tag_new": [
      {
        "TagItemId": 53,
        "TagName": "newTagName123"
      }
    ]
  },
  "error": null
}

rename

tag rename newTagName123 testing123x
{
  "status": "DN_NOTIFICATION",
  "request_id": null,
  "result": {
    "tag_rename": [
      {
        "TagItemId": 49,
        "TagName": "newTagName123",
        "NewName": "testing123x"
      }
    ]
  },
  "error": null
}

delete / forcedelete

tag delete tagToDelete
{
  "status": "DN_NOTIFICATION",
  "request_id": null,
  "result": {
    "tag_delete": [
      {
        "TagItemId": 54,
        "TagName": "tagToDelete"
      }
    ]
  },
  "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	tag_add	name
delete	tag_delete	name
forcedelete	tag_forcedelete	name
list	tag_list	—
rename	tag_rename	name new_name

See also

• devicetag: assign tags to devices, walls, multiviews, and presets
• taggroup: group tags together