Get Category
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Fetches the category information for the given category identifier. In order to view the category information, you need the read privilege on the category.
Request
URLURL
https://{api_host}/rest/com/vmware/cis/tagging/category/id:{category_id}
Parameters
Parameters
string
category_id
Required
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
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
TaggingCategoryGetResponseBody
of type application/json
The CategoryModel that corresponds to categoryId.
{
"value": {
"associable_types": [
"string"
],
"cardinality": "enum",
"description": "string",
"id": "string",
"name": "string",
"used_by": [
"string"
]
}
}cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/com/vmware/cis/tagging/category/id:{category_id}
Errors
404
com.vmware.vapi.std.errors.not_found : if the category for the given categoryId does not exist in the system.
401
com.vmware.vapi.std.errors.unauthorized : if you do not have the privilege to read the category.
Category Operations
get
post
get
patch
delete
