How to Copy a Pinboard Using Bold BI REST API

This article provides a comprehensive guide on how to copy a 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.

CodeAuthorization: bearer <token>

Endpoints

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

Bold BI Cloud Server

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

Request Type

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

Steps to Copy a Pinboard Using the REST API

To copy 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/copy

2. Add the Authorization Header

Include the access token in the request headers:
```
CodeAuthorization: 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",
  "TargetHomepageName": "string",
  "TargetUserEmail": "string"
}
```
Specify the name of the copy pinboard in the HomepageName property, the pinboard to be copied in the TargetHomepageName property, and the email address of the user from whom the pinboard will be copied in the TargetUserEmail property.

Example JSON data

{
  "HomepageName": "OrderAccuracyRateCopy",
  "TargetHomepageName": "OrderAccuracyRate",
  "TargetUserEmail": "[email protected]"
}

4. Send the Request

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

copypinboard

Responses

200 - Pinboard has been copied 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 copy pinboard details.

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

Additional References

Was this article useful?

Dislike

Written by Sammanasu Mary Jesuraj

Updated:

Comments (0)