Tagging Batch APIs

Tagging Batch APIs

The Batch service provides operations to query category, tag, and tag association information in batch. All operations return successfully. Error or insufficient privilege on an individual object will not result in a thrown exception, instead it will just be skipped. Note: This service is restricted for VMware internal use only.

Operations

Find Tags By Name Batch Internal

Enumerates all tags containing tagName in its names. You should note that tag names are only unique under its own category. To invoke this opertaion, you need the read privilege on each tag.

Get All Categories Batch Internal

Fetches all the category information in the system. You need the read privilege on each category to view its information.

Get All Tags Batch Internal

Fetches all tag information in the system. You need the read privilege on each tag to view its information.

Get Categories Batch Internal

Fetches the category information for the given category identifiers. You need the read privilege on each category to view its information.

Get Tags Batch Internal

Fetches the tag information for the given tag identifiers. You need the read privilege on each tag to view its information.

List All Attached Objects On Tags Batch Internal

Fetches the list of tag identifier to the identifiers of the objects its attached to for all tags in the system. To invoke this operation, you need the read privilege on each tag to be returned. The list of object identifiers will only contain those objects for which you have read privileges.

List Attached Objects Batch Internal

Fetches the list of object identifiers to which the input tags are attached. Objects will only appear once in the list regardless of if several input tags are attached to it. To invoke this operation, you need the read privilege on each input tag. The list of object identifiers will only contain those objects for which you have read privileges. Note that this operation does not preserve the mappings between tag identifier and object identifiers.

List Attached Objects On Tags Batch Internal

Fetches the list of tag identifier to the identifiers of the objects its attached to. To invoke this operation, you need the read privilege on each input tag. The list of object identifiers will only contain those objects for which you have read privileges.

List Attached Tags Batch Internal

Fetches the list of tag identifiers of the tags attached to the input objects. Tags will only appear once in the list regardless of if they are attached to several of the input objects. To invoke this operation, you need the read privilege on each input object. The list of tag identifiers will only contain those tags for which you have read privileges. Note that this operation does not preserve the mappings between object identifier and tag identifiers.

List Attached Tags On Objects Batch Internal

Fetches the list of object identifier to the identifiers of the tags attached to that object. To invoke this operation, you need the read privilege on each input object. The list of tag identifiers will only contain those tags for which you have read privileges.

List Tags For Categories Batch Internal

Enumerates all tags for the given @{term list} of categories. To invoke this operation, you need the read privilege on each category and the individual tags in that category.