1. Operations
  2. cis
  3. tagging
  4. tag association

cis tagging tag association: list attached tags on objects

Fetches the array of cis.tagging.tag_association.object_to_tags describing the input object identifiers and the tags attached to each object. To invoke this operation, you need the read privilege on each input object. The cis.tagging.tag_association.object_to_tags.tag_ids will only contain those tags for which you have the read privilege.

Request:

HTTP request

POST https://{server}/rest/com/vmware/cis/tagging/tag-association?~action=list-attached-tags-on-objects

Request Body Structure:

{
    "object_ids": [
        {
            "id": "obj-103",
            "type": "string"
        },
        {
            "id": "obj-103",
            "type": "string"
        }
    ]
}
<?xml version="1.0" ?>
<ns0:ListAttachedTagsOnObjects-Input xmlns:ns0="http://vmware.com/cis/tagging/tag_association" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <object_ids-array>
    <array-item>
      <id>obj-103</id>
      <type>string</type>
    </array-item>
    <array-item>
      <id>obj-103</id>
      <type>string</type>
    </array-item>
  </object_ids-array>
</ns0:ListAttachedTagsOnObjects-Input>

Request Body Parameters:

Name Type Description
bold = required
object_ids dynamic_ID[] The identifiers of the input objects.
object_ids[].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_ids[].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": [
        {
            "object_id": {
                "id": "obj-103",
                "type": "string"
            },
            "tag_ids": [
                "obj-103",
                "obj-103"
            ]
        },
        {
            "object_id": {
                "id": "obj-103",
                "type": "string"
            },
            "tag_ids": [
                "obj-103",
                "obj-103"
            ]
        }
    ]
}
<?xml version="1.0" ?>
<ns0:ListAttachedTagsOnObjects-Result xmlns:ns0="http://vmware.com/cis/tagging/tag_association" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value-array>
    <array-item>
      <tag_ids-array>
        <array-item>obj-103</array-item>
        <array-item>obj-103</array-item>
      </tag_ids-array>
      <object_id>
        <id>obj-103</id>
        <type>string</type>
      </object_id>
    </array-item>
    <array-item>
      <tag_ids-array>
        <array-item>obj-103</array-item>
        <array-item>obj-103</array-item>
      </tag_ids-array>
      <object_id>
        <id>obj-103</id>
        <type>string</type>
      </object_id>
    </array-item>
  </value-array>
</ns0:ListAttachedTagsOnObjects-Result>

Response Type:

Name Type Description
bold = required
value object_to_tags[] The array of the object identifiers to all tag identifiers that are attached to that object.
value[].object_id dynamic_ID The identifier of the object.
value[].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.
value[].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.
value[].tag_ids string[] The identifiers of the related tags.

When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.cis.tagging.Tag. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Errors:

None