Get Category Deprecated
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}
Path Parameters
Path 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, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
TaggingCategoryGetResponseBody of type application/json
The CategoryModel that corresponds to categoryId.
{
"value": {
"associable_types": [
"string"
],
"cardinality": "SINGLE",
"description": "string",
"id": "string",
"name": "string",
"used_by": [
"string"
]
}
}
Errors
403
com.vmware.vapi.std.errors.unauthorized : if you do not have the privilege to read the category.
404
com.vmware.vapi.std.errors.not_found : if the category for the given categoryId does not exist in the system.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/com/vmware/cis/tagging/category/id:{category_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: get
x-vmw-doc-new-path: /api/cis/tagging/category/{category_id}
x-vmw-doc-operation: get
On This Page
Category Operations
get
post
get
patch
delete
