Articles in this section
Category / Section

How to Get a Specific Slideshow Details using REST API

Published:

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

Authorization

To execute this action, please ensure that an 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>

Self-Hosted Server

For self-hosted instances, use the following endpoint:

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

Bold BI Cloud Server

For Bold BI Cloud instances, the endpoint is:

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

Request Type

  • GET: This request type is used to get a specific slideshow details.

Example Request

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

image.png

For more information on slideshows, please refer to this documentation.

Responses

  • 200: Slideshow detail was retrieved 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 GET.
  • 406: The content of the request body is invalid.
  • 417: Failed to retrieve the slideshows.

Reference

Was this article useful?
Like
Dislike
Help us improve this page
Please provide feedback or comments
SG
Written by Sivabalan Ganesan
Updated:
Comments (0)
Please  to leave a comment
Access denied
Access denied