com.vmware.cis.tagging.tag

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

list_tags_for_category

POST /com/vmware/cis/tagging/tag/id:{category_id}?~action=list-tags-for-category
POST /com/vmware/cis/tagging/tag?~action=list-tags-for-category

Enumerates all tags for the given category. To invoke this operation, you need the read privilege on the given category and the individual tags in that category.
Request:
Representations:
{
    "category_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:ListTagsForCategory-Input xmlns:ns0="http://vmware.com/cis/tagging/tag" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <category_id>obj-103</category_id>
</ns0:ListTagsForCategory-Input>
POST /com/vmware/cis/tagging/tag?~action=list-tags-for-category
&category_id=obj-103

Parameters:
Name Type Required Description
category_id
 *
 ID Yes The identifier of the input category. Id of type com.vmware.cis.tagging.Category.

Response:
Representations:
{
    "value": [
        "obj-103",
        "obj-103"
    ]
}
<?xml version="1.0" ?>
<ns0:ListTagsForCategory-Result xmlns:ns0="http://vmware.com/cis/tagging/tag" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value-array>
    <array-item>obj-103</array-item>
    <array-item>obj-103</array-item>
  </value-array>
</ns0:ListTagsForCategory-Result>

Parameters:
Name Type Required Description
result List<ID> Yes The array of resource identifiers for the tags in the given input category. Id of type com.vmware.cis.tagging.Tag.

Errors:
Type Description HTTP Status Code
not_found if the category for the given category_id does not exist in the system. 404
unauthorized if you do not have the privilege to read the category. 403

Copyright © 2014. All Rights Reserved.