This API has a deprecated equivalent from v7.0U1.
List Attachable Tags Tag Association
Fetches the list of attachable tags for the given object, omitting the tags that have already been attached. Criteria for attachability is calculated based on tagging cardinality (CategoryModel.cardinality) and associability (CategoryModel.associable-types) constructs. To invoke this operation, you need the read privilege on the input object. The list will only contain those tags for which you have read privileges.
Request
URLURL
https://{api_host}/api/cis/tagging/tag-association?action=list-attachable-tags
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
TaggingTagAssociationListAttachableTagsRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"object_id": {
"id": "string",
"type": "string"
}
}
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
string
of type application/json
The list of tag identifiers that are eligible to be attached to the given object. The result will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if you do not have the privilege to read the object.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$StdDynamicID = Initialize-StdDynamicID -Type "MyType" -Id "MyId"
$TaggingTagAssociationListAttachableTagsRequestBody = Initialize-TaggingTagAssociationListAttachableTagsRequestBody -ObjectId $StdDynamicID
Invoke-ListAttachableTagsTagAssociation -TaggingTagAssociationListAttachableTagsRequestBody $TaggingTagAssociationListAttachableTagsRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{}' https://{api_host}/api/cis/tagging/tag-association?action=list-attachable-tags
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/com/vmware/cis/tagging/tag-association?~action=list-attachable-tags
x-vmw-doc-operation: list_attachable_tags
Availability
Added in 7.0U2
