This section explains how to create, open, update, delete, and manage share permissions for categories in Bold Reports On-Premise. Accessibility to categories depends on the user’s permissions.
Categories are displayed on the left side of the report listing page.
To open the already created category, click any category in the left panel to view the reports grouped with it.
To add a new category, you must have the Create All Categories
permission.
There are several ways to add a category, as follows:
New Category
option will be displayed.
[+]
icon in the toolbar, then select the Create Category
option .
Provide a name and description (optional) for the category and click Add.
The user who created the category is provided with
Read
,Write
,Delete
permissions for that specific category.
In the Report Server, you have the ability to set permissions for categories, allowing you to share them with other users.
Manage Access
button.
Only the user who has permission can share the category with other Report Server users.
A user with the appropriate permissions can remove the shared Category permissions using the Remove option
.
A category that can be pinned or prioritized for quick access.
Pin
option in the context menu of the category.
To update the name and description of a category that has already been created, please follow these steps:
You have the ability to delete a category from the Report Server. To do so, please follow these steps:
A category that contains grouped reports cannot be deleted.
The following table illustrates the list of available APIs related to category in Bold Reports On-Premise.
Action | HTTP Method | Endpoint | Description |
---|---|---|---|
AddCategory | POST | /api/site/{tenant-name}/v1.0/categories | Adds a new category to the server. Category details must be passed as input. |
UpdateCategory | PUT | /api/site/{tenant-name}/v1.0/categories | Updates the category on the server. Updated category details must be passed as input. |
GetCategory | GET | /api/site/{tenant-name}/v1.0/items | Returns the list of categories for the current user. ItemType should be Category. |
IsCategoryNameExists | POST | /api/site/{tenant-name}/v1.0/items/is-name-exists | Returns an item's existence, whether the given category name already exists or not on the server. Category name and ItemType as Category should be passed in the request body. |
GetCategoryDetail | GET | /api/site/{tenant-name}/v1.0/items/{id} | Returns the specified category details from the server. Category item ID should be passed in the path parameter. |
DeleteCategory | DELETE | /api/site/{tenant-name}/v1.0/items/{id} | Deletes the specified category from the server. Category item ID should be passed in the path parameter. |