How to Create a Pinboard Using Bold BI REST API

This article provides a comprehensive guide on how to create a new pinboard on a specific site using the REST API.

Authorization

To perform this action, an access token must be included in the request header. For details on obtaining the access token, please refer to the relevant documentation here.

Authorization: bearer <token>

Endpoints

Self-Hosted Server
https://{yourdomain}/bi/api/site/<site_identifier>/v6.0/pinboard

Bold BI Cloud Server

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

Request Type

POST: This request type is used to create the pinboard.

Steps to Create a Pinboard Using the REST API

To create a pinboard, follow the steps outlined below:

Configure the Endpoint

In your API client, set the request to POST and use the endpoint:

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

2. Add the Authorization Header

Include the access token in the request headers:
```
Authorization: bearer <Your_token>
```

3. Set Up the Request Body

In the Body tab, select raw and set the format to JSON. Provide the details in the following structure:

{
  "HomepageName": "string",
  "Pininfo": [
    {
      "WidgetName": "string",
      "WidgetId": "string",
      "DashboardId": "string"
    }
  ]
}

Add the pinboard name in HomepageName property
Replace WidgetName, WidgetId, and DashboardId properties with the actual values. Refer to the following knowledgebase articles to retrieve these details
How to retrieve widget information from a dashboard.
How to get dashboard details.

Example JSON data

{
"HomepageName": "AddPinboardAPI",
"Pininfo": [
{
"WidgetName":"RadialGauge1",
"WidgetId": "7c0770d8-c317-4e41-91da-e5463d463a59",
"DashboardId": "6a246819-daec-4b94-806f-5de9faa3f2da"
}
]
}

4. Send the Request

Execute the request by pressing Send icon. If successful, the response will indicate that the pinboard has been created with a status code of 200.

Responses

200 - Pinboard has been added successfully.
400 - The content of the request body is missing or incomplete.
405 - Request type was not POST.
406 - The content of the request body is invalid.
409 - Pinboard name already exist.
417 - Failed to add pinboard details.

By following these instructions, you can successfully add a pinboard within your Bold BI environment.

Additional References

Was this article useful?

Dislike

Written by Sammanasu Mary Jesuraj

Updated:

Comments (0)