How to modify the name of existing category in dashboard listing page via REST API ?

Published:

This article provides a step-by-step guide on how to update or modify an existing category name in the dashboard listing page via REST API. You must have write access to categories to perform this operation.

Authorization

To execute this action, please ensure that a access token is included in your request header. For details on obtaining the access token, please refer to the relevant documentation here.

Authorization: bearer <token>

To modify the name of existing category in dashboard listing page, you will need to send a PUT request to the appropriate endpoint based on your server type as shown below :

Self-Hosted Server

For self-hosted instances, use the following endpoint:

https://{yourdomain}/bi/api/site/<site_identifier>/v4.0/categories

Bold BI Cloud Server

For Bold BI Cloud instances, the endpoint is:

https://{yourdomain}/bi/api/v4.0/categories

Request Type

PUT: This request type is used to update or modify the name of an existing category in the dashboard listing page.

Example Request

Here is an example of how to structure your PUT request:

Request Body Schema

The request body should contain the following fields:

CategoryId (required): A unique identifier for the category you wish to update. It should be in the format of a GUID (Globally Unique Identifier). To get this category id, follow the steps outlined in the following KB
Name (optional): The new name for the category.
Description (optional): A description for the category.

Example Request Body

{
  "CategoryId": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "Updated Category Name",
  "Description": "Updated description of the category."
}

Responses

The API will return different responses based on the outcome of the request:

200 OK: The category was modified successfully.
400 Bad Request: The request body is missing or incomplete. Ensure all required fields are included.
401 Unauthorized: Access is denied. Verify that your bearer token is correct and you have the necessary permissions.
404 Not Found: The specified category ID does not exist.
405 Method Not Allowed: The request method is not PUT. Ensure you are using a PUT request.
406 Not Acceptable: The content of the request body is invalid. Check the format and data types.
409 Conflict: The category name already exists. Choose a different name.
417 Expectation Failed: The category update failed due to an unspecified error.