How to Publish the Multi-Tab dashboard using REST API

This article explains how to add or publish the multi-tab dashboard using API calls in Bold BI On-Premises using Postman.

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>

Follow these steps to create a custom widget using API calls:

1. Use the below endpoint in postman with POST method

   http(s)://{your host}:{your port number}/bi/api/site/{your_site_identifier}/v5.0/multi-tab
   

2. Then add the token generated from the ‘token’ endpoint above in the Headers with key as ‘Authorization’ and value as ‘bearer {Your_token}’
   

   

3. In the Body tab, select the raw option and choose JSON format. Then enter the following JSON schema:

   {
       "Name": "Sample Multi Tab Dashboard",
       "Description": "A simple test dashboard",
       "CategoryId": "dc56f717-bfcf-4e08-ab42-8b207c726ef4",
       "TabList": [
           {
               "OrderNumber": 0,
               "ItemInfo": {
                   "Id": "bd1a3355-b357-4cbf-a685-2be76e55ab34",
                   "TabName": "Tab 1"
               }
           },
           {
               "OrderNumber": 1,
               "ItemInfo": {
                   "Id": "93dd7406-f21b-427f-a6f2-1b9e8e5898io",
                   "TabName": "Tab 2"
               }
           }
       ]
   }
   

   Note: Make sure to replace the CategoryId and the Id values in the TabList with the appropriate identifiers from your existing dashboards or content. You can find the ‘Dashboard Id’ by referring to the knowledge base article linked here.

4. After configuring the request, click the Send button in Postman. On a successful request, you will receive a success response indicating that the multi-tab dashboard has been created.

   

Response

• 200 OK - Multi-tabbed dashboard has been added successfully.
• 400 Bad Request - Invalid Body syntax - Connector name or Connection JSON is invalid or Empty.
• 401 Unauthorized - Authorization toke is invalid, or token has expired.
• 409 Conflict - Connector name already exists.

Reference

• How do I create a dashboard view using Bold BI REST API.
• How to Publish a Multi-Tabbed Dashboard in Bold BI.