REST API - tag

tag_model

The tag_model structure defines a tag that can be attached to vSphere objects.

Representations:

JSON
XML

{
    "category_id": "obj-103",
    "description": "string",
    "id": "obj-103",
    "name": "string",
    "used_by": [
        "string",
        "string"
    ]
}

<?xml version="1.0" ?>
<ns0:TagModel xmlns:ns0="http://vmware.com/cis/tagging" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <id>obj-103</id>
  <description>string</description>
  <name>string</name>
  <used_by-array>
    <array-item>string</array-item>
    <array-item>string</array-item>
  </used_by-array>
  <category_id>obj-103</category_id>
</ns0:TagModel>

Attributes:

Name	Type	Required	Description
id *	ID	Yes	The unique identifier of the tag. Id of type com.vmware.cis.tagging.Tag.
category_id *	ID	Yes	The identifier of the parent category in which this tag will be created. Id of type com.vmware.cis.tagging.Category.
name *	string	Yes	The display name of the tag.
description *	string	Yes	The description of the tag.
used_by *	Set<string>	Yes	The set of users that can use this tag. To add users to this, you need to have the edit privilege on the tag. Similarly, to unsubscribe from this tag, you need the edit privilege on the tag. You should not modify other users subscription from this set.

com.vmware.cis.tagging

tag_model