vcenter tagging associations: list result

The list_result structure contains the list of tag associations in a page, as well as related metadata fields. This structure was added in vSphere API 7.0.0.

Representation:

{
    "associations"[
        {
            "tag""obj-103",
            "object"{
                "id""obj-103",
                "type""string"
            }
        },
        {
            "tag""obj-103",
            "object"{
                "id""obj-103",
                "type""string"
            }
        }
    ],
    "marker""obj-103",
    "status""READY"
}

Attributes:

Name Type Description
Required
associations summary[] List of tag associations. This attribute was added in vSphere API 7.0.0.

associations[].tag string The identifier of a tag. This attribute was added in vSphere API 7.0.0.

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.

associations[].object dynamic_ID The identifier of an associated object. This attribute was added in vSphere API 7.0.0.

associations[].object.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.

associations[].object.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.

status string The last status for the iterator that indicates whether any more results can be expected if the caller continues to make requests for more data using the iterator. This attribute was added in vSphere API 7.0.0.

The last status for the iterator. A field of this type is returned as part of the result and indicates to the caller of the API whether it can continue to make requests for more data.

The last status only reports on the state of the iteration at the time data was last returned. As a result, it not does guarantee if the next call will succeed in getting more data or not.

Failures to retrieve results will be returned as Error responses. These last statuses are only returned when the iterator is operating as expected.

. This enumeration was added in vSphere API 7.0.0. Value is one of:
READY: Iterator has more data pending and is ready to provide it. The caller can request the next page of data at any time.

The number of results returned may be less than the usual size. In other words, the iterator may not fill the page. The iterator has returned at least 1 result.

. This constant was added in vSphere API 7.0.0.
END_OF_DATA: Iterator has finished iterating through its inventory. There are currently no more entities to return and the caller can terminate iteration. If the iterator returned some data, the marker may be set to allow the iterator to continue from where it left off when additional data does become available. This value is used to indicate that all available data has been returned by the iterator. This constant was added in vSphere API 7.0.0.
Optional
marker string Marker is an opaque data structure that allows the caller to request the next page of tag associations. This attribute was added in vSphere API 7.0.0.

Optional. If unset or empty, there are no more tag associations to request.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.tagging.associations.Marker. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.tagging.associations.Marker.