Add To Used By Category
Adds the usedByEntity to the CategoryModel.used-by subscribers set for the specified category. If the usedByEntity is already in the set, then this becomes an idempotent no-op. To invoke this operation, you need the modify CategoryModel.used-by privilege on the category.
Request
URLURL
https://{api_host}/rest/com/vmware/cis/tagging/category/id:{category_id}?~action=add-to-used-by
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, acquired from Create Session API under CIS product
vmware-api-session-id Example
b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
TaggingCategoryAddToUsedByRequestBody of type application/json (required){
"used_by_entity": "string"
}
string
used_by_entity
Required
The name of the user to be added to the CategoryModel.used-by set.
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"used_by_entity":"string"}' https://{api_host}/rest/com/vmware/cis/tagging/category/id:{category_id}?~action=add-to-used-by
Errors
401
com.vmware.vapi.std.errors.unauthorized : if you do not have the privilege to add an entity to the CategoryModel.used-by field.
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.
On This Page
Category Operations
get
post
get
patch
delete
