cis tagging tag association: 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 (cis.tagging.category_model.cardinality) and associability (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:
HTTP request
POST https://{server}/rest/com/vmware/cis/tagging/tag-association?~action=list-attachable-tags
Request Body Structure:
{
"object_id": {
"id": "obj-103",
"type": "string"
}
}
"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>
<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>
Request Body Parameters:
Name | Type | Description |
---|---|---|
bold = required | ||
object_id | dynamic_ID | The identifier of the input object. |
object_id.type | string | The type of resource being identified (for example com.acme.Person ). Services that contain operations for creating and deleting resources typically contain a constant specifying the resource type for the resources being created and deleted. The API metamodel metadata services include a service that allows retrieving all the known resource types. |
object_id.id | string | The identifier for a resource whose type is specified by vapi.std.dynamic_ID.type. When clients pass a value of this structure as a parameter, the field type must contain the actual resource type. When operations return a value of this structure as a result, the field type will contain the actual resource type. |
Response:
HTTP Status Code: 200
Representations:
{
"value": [
"obj-103",
"obj-103"
]
}
"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>
<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>
Response Type:
Name | Type | Description |
---|---|---|
bold = required | ||
value | string[] | The array of tag identifiers that are eligible to be attached to the given object. |
Errors:
HTTP Status Code | Type | Description |
---|---|---|
403 | unauthorized | if you do not have the privilege to read the object. |