Category APIs
The Category service provides operations to create, read, update, delete, and enumerate categories.
Operations
POST
Add To Used By Category Id
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.
POST
Create Category
Creates a category. To invoke this operation, you need the create category privilege.
GET
List Category
Enumerates the categories in the system. To invoke this operation, you need the read privilege on the individual categories. The list will only contain those categories for which you have read privileges.
DELETE
Delete Category Id
Deletes an existing category. To invoke this operation, you need the delete privilege on the category.
GET
Get Category Id
Fetches the category information for the given category identifier. In order to view the category information, you need the read privilege on the category.
PATCH
Update Category Id
Updates an existing category. To invoke this operation, you need the edit privilege on the category.
POST
List Used Categories Category
Enumerates all categories for which the usedByEntity is part of the CategoryModel.used-by subscribers set. To invoke this operation, you need the read privilege on the individual categories.
POST
Remove From Used By Category Id
Removes the usedByEntity from the CategoryModel.used-by subscribers set. If the usedByEntity is not using this category, then this becomes a no-op. To invoke this operation, you need the modify CategoryModel.used-by privilege on the category.
POST
Revoke Propagating Permissions Category Id
Revokes all propagating permissions on the given category. You should then attach a direct permission with tagging privileges on the given category. To invoke this operation, you need category related privileges (direct or propagating) on the concerned category.