com.vmware.cis.tagging.tag_association

The tag_association service provides operations to attach, detach, and query tags.

list_attachable_tags

POST /com/vmware/cis/tagging/tag-association?~action=list-attachable-tags

Fetches the array of attachable tags for the given object, omitting the tags that have already been attached. Criteria for attachability is calculated based on tagging cardinality (com.vmware.cis.tagging.category_model.cardinality) and associability (com.vmware.cis.tagging.category_model.associable_types) constructs. To invoke this operation, you need the read privilege on the input object. The array will only contain those tags for which you have read privileges.
Request:
Representations:
{
    "object_id": {
        "id": "obj-103",
        "type": "string"
    }
}
<?xml version="1.0" ?>
<ns0:ListAttachableTags-Input xmlns:ns0="http://vmware.com/cis/tagging/tag_association" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <object_id>
    <id>obj-103</id>
    <type>string</type>
  </object_id>
</ns0:ListAttachableTags-Input>
POST /com/vmware/cis/tagging/tag-association?~action=list-attachable-tags
&object_id.id=obj-103
&object_id.type=string

Parameters:
Name Type Required Description
object_id
 *
 dynamic_ID Yes The identifier of the input object.

Response:
Representations:
{
    "value": [
        "obj-103",
        "obj-103"
    ]
}
<?xml version="1.0" ?>
<ns0:ListAttachableTags-Result xmlns:ns0="http://vmware.com/cis/tagging/tag_association" 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:ListAttachableTags-Result>

Parameters:
Name Type Required Description
result List<ID> Yes The array of tag identifiers that are eligible to be attached to the given object. Id of type com.vmware.cis.tagging.Tag.

Errors:
Type Description HTTP Status Code
unauthorized if you do not have the privilege to read the object. 403

Copyright © 2014. All Rights Reserved.