Developer Documentation
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
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category. |
Request Body
Request Body
Contains
AddToUsedByRequestBody
of type application/json
(required)
{
"used_by_entity": "string"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | used_by_entity | string |
The name of the user to be added to the CategoryModel.used-by set. |
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthorized : if you do not have the privilege to add an entity to the CategoryModel.used-by field. |
| 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
