Developer Documentation
Get Category
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
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | The identifier of category to be deleted. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category. |
Response
Response
Response BodyResponse Body
200 OK returns
GetResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains: The CategoryModel that corresponds to categoryId.
{
"value": {
"associable_types": [
"string"
],
"cardinality": "enum",
"description": "string",
"id": "string",
"name": "string",
"used_by": [
"string"
]
}
}| Property Name | Type | Description |
|---|---|---|
| value | TaggingCategoryModel |
The CategoryModel that corresponds to categoryId. |
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthorized : if you do not have the privilege to read the category. |
| 404 | Error | com.vmware.vapi.std.errors.not_found : if the category for the given categoryId does not exist in the system. |
| default | Error | Not available |
On This Page
Category Operations
get
post
get
patch
delete
