This API has a deprecated equivalent from v7.0U1.
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}/api/cis/tagging/category/{category_id}?action=add-to-used-by
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"
Request Body
Request Body
TaggingCategoryAddToUsedByRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"used_by_entity": "string"
}
string
used_by_entity
Required
The name of the user to be added to the CategoryModel.used-by set.
Authentication
This operation uses the following authentication methods.
Errors
Errors
403
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.
Code Samples
PowerCLI Client SDK Example
$TaggingCategoryAddToUsedByRequestBody = Initialize-TaggingCategoryAddToUsedByRequestBody -UsedByEntity "MyUsedByEntity"
Invoke-AddToUsedByCategoryId -CategoryId "MyCategoryId" -TaggingCategoryAddToUsedByRequestBody $TaggingCategoryAddToUsedByRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"used_by_entity":"string"}' https://{api_host}/api/cis/tagging/category/{category_id}?action=add-to-used-by
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/com/vmware/cis/tagging/category/id:{category_id}?~action=add-to-used-by
x-vmw-doc-operation: add_to_used_by
Availability
Added in 7.0U2
On This Page
Category Operations
get
post
delete
get
patch
