List Tags For Category Tag
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Enumerates all tags for the given category. To invoke this operation, you need the read privilege on the given category and the individual tags in that category.
Request
URLURL
https://{api_host}/rest/com/vmware/cis/tagging/tag/id:{category_id}?~action=list-tags-for-category
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
TaggingTagListTagsForCategoryResponseBody
of type application/json
The list of resource identifiers for the tags in the given input category. The result will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.
{
"value": [
"string"
]
}| Property Name | Type | Description |
|---|---|---|
| value | array of string |
The list of resource identifiers for the tags in the given input category. The result will contain identifiers for the resource type: com.vmware.cis.tagging.Tag. |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/com/vmware/cis/tagging/tag/id:{category_id}?~action=list-tags-for-category
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : if the category for the given categoryId does not exist in the system. |
| default | ErrorRest | Not available |
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthorized : if you do not have the privilege to read the category. |
Tag Operations
get
post
get
patch
delete
post
post
