How to Update a Slideshow Using the REST API

Users who have write access to the slideshow can update the details of the slideshow. This article provides comprehensive guidance on how to update an existing 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/{slideshowId}

Bold BICloud Server

For Bold BI Cloud instances, use the following endpoint:

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

Make sure to replace {slideshowId} with the actual ID of the slideshow to be updated. The slideshow ID and related details can be retrieved by following the instructions provided in this knowledge base article.

Request Type

PUT: This request type is used to update a slideshow.

Body

In the body of this API request, you may provide the required slideshow name and duration value and the order number of slides.

Additionally, you can add a new slide by specifying the necessary dashboard ID, dashboard name, corresponding dashboard category ID, and category name.

You may also remove unwanted slides by deleting existing slides from the list.

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": "slideshowapiupdate",
  "Duration": 10,
  "Slides": [
    {
      "OrderNumber": 3,
      "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": 1,
      "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
      }
    },
    {
      "OrderNumber": 2,
      "ItemType": "Dashboard",
      "ItemInfo": {
        "Id": "366c459d-4ceb-4072-8ba5-7f1172965744",
        "Name": "Snow Dashboard",
        "CategoryId": "ee5f0c3c-9605-4736-a430-740713c3bcaf",
        "CategoryName": "Getting Started Tutorial",
        "TabId": "",
        "TabName": "",
        "ViewId": "",
        "ViewName": "",
        "IsActive": true
      }
    }
  ]
}

Example Request

updateslideshow

For more information on slideshows, refer to this documentation.

Responses

200 - A slideshow was modified successfully.
400 - The content of the request body is missing or incomplete.
401 - Access denied.
404 - Item details not found.
405 - Request type was not PUT.
406 - The content of the request body is invalid.
417 - Failed to update slideshow.

Additional References:

Was this article useful?

Dislike

Written by Sammanasu Mary Jesuraj

Updated:

Comments (0)