com.vmware.cis.tagging.tag

The tag service provides operations to create, read, update, delete, and enumerate tags.

get

GET /com/vmware/cis/tagging/tag/id:{tag_id}
POST /com/vmware/cis/tagging/tag/id:{tag_id}?~action=get
POST /com/vmware/cis/tagging/tag?~action=get

Fetches the tag information for the given tag identifier. To invoke this operation, you need the read privilege on the tag in order to view the tag info.
Request:
Representations:
{
    "tag_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Get-Input xmlns:ns0="http://vmware.com/cis/tagging/tag" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <tag_id>obj-103</tag_id>
</ns0:Get-Input>
POST /com/vmware/cis/tagging/tag?~action=get
&tag_id=obj-103

Parameters:
Name Type Required Description
tag_id
 *
 ID Yes The identifier of the input tag. Id of type com.vmware.cis.tagging.Tag.

Response:
Representations:
{
    "value": {
        "category_id": "obj-103",
        "description": "string",
        "id": "obj-103",
        "name": "string",
        "used_by": [
            "string",
            "string"
        ]
    }
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/cis/tagging/tag" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <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>
  </value>
</ns0:Get-Result>

Parameters:
Name Type Required Description
result tag_model Yes The com.vmware.cis.tagging.tag_model that corresponds to tag_id.

Errors:
Type Description HTTP Status Code
not_found if the tag for the given tag_id does not exist in the system. 404
unauthorized if the user does not have the privilege to read the tag. 403

Copyright © 2014. All Rights Reserved.