How to Check Whether a Pinboard Name Exists Using the Bold BI REST API
Published:
The current user can check whether the pinboard already exists by providing the name of a pinboard. This article provides a comprehensive guide on how to check whether a pinboard name exists using the Bold BI 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/is-name-exists
Bold BI Cloud Server
https://{yourdomain}/bi/api/v6.0/pinboard/is-name-exists
Request Type
- POST: This request type is used to confirm whether the pinboard name exists in the Bold BI application.
Steps to Check Whether a Pinboard Name Exists Using the Bold BI REST API
- 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/is-name-exists
- Add the Authorization Header
Include the access token in the request headers:
Authorization: bearer <token>
3. Send the request
Execute the request by pressing Send icon. If the request is successful, it will return the response as true.
Responses
200- Returns an item existence
400- The content of the request body is missing or incomplete.
405- Request type was not POST.
500- Error in database while executing the query
Additional References
SM
