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

cis tagging tag association: list attached objects on tags

Fetches the array of cis.tagging.tag_association.tag_to_objects describing the input tag identifiers and the objects they are attached to. To invoke this operation, you need the read privilege on each input tag. The cis.tagging.tag_association.tag_to_objects.object_ids will only contain those objects for which you have the read privilege.

Request:

HTTP request

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

Request Body Structure:

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

Request Body Parameters:

Name Type Description
bold = required
tag_ids string[] The identifiers of the input tags.

Response:

HTTP Status Code: 200

Representations:

{
    "value": [
        {
            "object_ids": [
                {
                    "id": "obj-103",
                    "type": "string"
                },
                {
                    "id": "obj-103",
                    "type": "string"
                }
            ],
            "tag_id": "obj-103"
        },
        {
            "object_ids": [
                {
                    "id": "obj-103",
                    "type": "string"
                },
                {
                    "id": "obj-103",
                    "type": "string"
                }
            ],
            "tag_id": "obj-103"
        }
    ]
}
<?xml version="1.0" ?>
<ns0:ListAttachedObjectsOnTags-Result xmlns:ns0="http://vmware.com/cis/tagging/tag_association" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value-array>
    <array-item>
      <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>
      <tag_id>obj-103</tag_id>
    </array-item>
    <array-item>
      <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>
      <tag_id>obj-103</tag_id>
    </array-item>
  </value-array>
</ns0:ListAttachedObjectsOnTags-Result>

Response Type:

Name Type Description
bold = required
value tag_to_objects[] The array of the tag identifiers to all object identifiers that each tag is attached to.
value[].tag_id string The identifier of the tag.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.tagging.Tag. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.tagging.Tag.
value[].object_ids dynamic_ID[] The identifiers of the related objects.
value[].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.
value[].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.

Errors:

None