How to Run a Specific Schedule using the REST API

This article explains how to run a specific schedule using the REST API in Bold BI. Users with read access to the schedule can execute it by following the steps outlined below.

Authorization

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

Steps to Run a Specific Schedule

To run a specific schedule, follow the steps outlined below:

1. Use the following endpoint in your API client (e.g., Postman):

   • For Self-Hosted Server:
     https://{yourdomain}/bi/api/site/<site_identifier>/v5.0/schedules/{scheduleId}/run

   • For Bold BI Cloud Server:
     https://{yourdomain}/bi/api/v5.0/schedules/{scheduleId}/run

   Make sure to replace {scheduleId} with the actual ID of the dashboard schedule you wish to delete. You can find the Schedule ID and details in this knowledge base article.

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. Click the “Send” button in your API client. If the request is successful, the schedule will start, and recipients will receive a notification once the schedule has been completed successfully.
   

   

For more information on managing the dashboard schedules, please refer to this documentation.

Response

• 200: The schedule started successfully. Recipients will be notified once the schedule is completed.
• 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 run the schedule.

Reference

• Create a Schedule to Export the Dashboard View using REST API
• How to get the dashboard schedules using REST API
• How to Delete a Dashboard Schedule using REST API