How to Add a Slideshow Using the REST API

Users who have created access to the slideshow can add a new slideshow. This article provides comprehensive guidance on how to add a new slideshow via REST API in Bold BI^.

^{Authorization}

^{To execute this action, ensure that an access token is included in the request header. For details on obtaining the access token, refer to the relevant documentation here.}

Authorization: bearer <token>

Self-Hosted Server

For self-hosted instances, use the following endpoint:

https://{yourdomain}/bi/api/site/<site_identifier>/v6.0/slideshows

Bold BICloud Server

For Bold BI^® Cloud instances, use the following endpoint:

https://{yourdomain}/bi/api/v6.0/slideshows

Request Type

POST: This request type is used to add a new slideshow.

Body

In the body of this API request, you must include the required dashboard Id, dashboard name, the corresponding dashboard category ID, and category name. These details can be provided in either raw JSON format or as a Form URL-Encoded request body.

To Get Dashboard ID:

For information on how to get the Dashboard ID in Bold BI, consult the relevant documentation here.

To Get Category ID:

For information on how to obtain the category list and each category ID, consult the relevant documentation here.

Example JSON data:

{
  "Name": "slideshowapi",
  "Duration": 5,
  "Slides": [
    {
      "OrderNumber": 1,
      "ItemType": "Dashboard",
      "ItemInfo": {
        "Id": "6a246819-daec-4b94-806f-5de9faa3f2da",
        "Name": "Supply Chain Performance Dashboard",
        "CategoryId": "ee5f0c3c-9605-4736-a430-740713c3bcaf",
        "CategoryName": "Getting Started Tutorial",
        "TabId": "",
        "TabName": "",
        "ViewId": "",
        "ViewName": "",
        "IsActive": true
      }
    },
    {
      "OrderNumber": 2,
      "ItemType": "Dashboard",
      "ItemInfo": {
        "Id": "9f798e82-7696-4a7e-8dcc-6fe4cc4c6f9d",
        "Name": "School Performance Dashboard",
        "CategoryId": "ee5f0c3c-9605-4736-a430-740713c3bcaf",
        "CategoryName": "Getting Started Tutorial",
        "TabId": "",
        "TabName": "",
        "ViewId": "",
        "ViewName": "",
        "IsActive": true
      }
    }
  ]
}

Example Request

Example Form URL-Encoded Request Body:

Name

SlideshowviaAPI

Duration

Slides

[
    {
      "OrderNumber": 1,
      "ItemType": "Dashboard",
      "ItemInfo": {
        "Id": "6a246819-daec-4b94-806f-5de9faa3f2da",
        "Name": "Supply Chain Performance Dashboard",
        "CategoryId": "ee5f0c3c-9605-4736-a430-740713c3bcaf",
        "CategoryName": "Getting Started Tutorial",
        "TabId": "",
        "TabName": "",
        "ViewId": "",
        "ViewName": "",
        "IsActive": true
      }
    },
    {
      "OrderNumber": 2,
      "ItemType": "Dashboard",
      "ItemInfo": {
        "Id": "9f798e82-7696-4a7e-8dcc-6fe4cc4c6f9d",
        "Name": "School Performance Dashboard",
        "CategoryId": "ee5f0c3c-9605-4736-a430-740713c3bcaf",
        "CategoryName": "Getting Started Tutorial",
        "TabId": "",
        "TabName": "",
        "ViewId": "",
        "ViewName": "",
        "IsActive": true
      }
    }
  ]

Example Request:

For more information on slideshows, refer to this documentation.

Responses

200 - A slideshow was created successfully.
400 - The content of the request body is missing or incomplete.
401 - Access denied.
405 - Request type was not POST.
406 - The content of the request body is invalid.
409 - Item name already exists.
417 - Failed to add slideshow.

Additional References:

Was this article useful?

Dislike

Written by Sammanasu Mary Jesuraj

Updated:

Comments (0)