This API has a deprecated equivalent from v7.0U1.
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}/api/cis/tagging/category/{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
TaggingCategoryModel
of type application/json
The CategoryModel that corresponds to categoryId.
{
"associable_types": [
"string"
],
"cardinality": "SINGLE",
"description": "string",
"id": "string",
"name": "string",
"used_by": [
"string"
]
}
array of
string
associable_types
Required
The types of objects that the tags in this category can be attached to. If the set is empty, then tags can be attached to all types of objects. This field works only for objects that reside in Inventory Service (IS). For non IS objects, this check is not performed today and hence a tag can be attached to any non IS object.
cardinality
Required
The CategoryModel.Cardinality enumerated type defines the number of tags in a category that can be assigned to an object.
SINGLE : An object can only be assigned one of the tags in this category. For example, if a category is “Operating System”, then different tags of this category would be “Windows”, “Linux”, and so on. In this case a VM object can be assigned only one of these tags and hence the cardinality of the associated category here is single.
MULTIPLE : An object can be assigned several of the tags in this category. For example, if a category is “Server”, then different tags of this category would be “AppServer”, “DatabaseServer” and so on. In this case a VM object can be assigned more than one of the above tags and hence the cardinality of the associated category here is multiple.
Possible values are: SINGLE , MULTIPLE
string
description
Required
The description of the category.
string
id
Required
The unique identifier of the category. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.tagging.Category. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.tagging.Category.
string
name
Required
The display name of the category.
array of
string
used_by
Required
The set of users that can use this category. To add users to this, you need to have the edit privilege on the category. Similarly, to unsubscribe from this category, you need the edit privilege on the category. You should not modify other users subscription from this set.
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
PowerCLI Client SDK Example
Invoke-GetCategoryId -CategoryId "MyCategoryId"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/cis/tagging/category/{category_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/com/vmware/cis/tagging/category/id:{category_id}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Category Operations
get
post
get
patch
delete
