How to publish dashboard with same name to destination site using Bold BI REST API

Published:

In Bold BI, you can use the dashboard publish API to publish a dashboard from one site to another with the same dashboard and data source name. This article will guide you through the process of using the API.

Authentication

When you sign into Bold BI, an authentication token is provided that should be attached in the request header (Authorization) for all subsequent API calls to authenticate the requests. To get the authorized token, refer to the following help documents:

API Endpoint

To publish the dashboard from one site to another, use the following API endpoint:

Method	Endpoint
POST	/v4.0/publish/item

Embedded Bold BI: {domain_name}/bi/api/site/{site_identifier}/v4.0/publish/item

Cloud Bold BI: {domain_name}/bi/api/v4.0/publish/item

Request Body

The request body should include the following details:

Name	Required	Type	Description
ItemId	Yes	Guid	Dashboard Id
TargetSiteDetails	Yes	List<ApiTargetSiteDetails>	Details of Target Site

ApiTargetSiteDetails Object

Name	Required	Type	Description
ClientId	Yes	Guid	Client Id.
SiteIdentifier	Yes	String	Site Identifier
CatagoryName	Yes	String	Category name in which the dashboard should be published
Description	Optional	String	Description of the dashboard
LockDashboard	Optional	Boolean	Lock the dashboard from editing
LockDatasource	Optional	Boolean	Lock data source from editing
UseSourceItemName	Optional	Boolean	Use same dashboard and data source name in source site
Datasources	Yes	List<DatasourceDetail>	Details of Data sources
PublishType	Yes	String	Internal or External

DatasourceDetail Object

Name	Required	Type	Description
Id	Yes	Guid	Data source Id
IsLocked	Optional	Boolean	Data source locked from editing

Client ID - You can get the client ID(s) of all tenants by using this Bold BI REST API response.

Item ID - By using this Bold BI REST API response, you can get the Item ID(s) of all the dashboards you have created.

Note

For Cloud Analytics Server PublishType - External only possible and for Embedded Analytics Server Internal is available only for Master site, External is available for all sites (both master and non-master sites)

Sample Request Body

To publish the dashboard with same name to destination site, set UseSourceItemName as True

{
    "ItemId": "74492926-edc7-4b11-9dcf-803cc32b32f0",
    "TargetSiteDetails": [
        {
        "ClientId": "6b0c90c9-aab6-4c5a-aa2b-e8a6807cfdc6",
        "SiteIdentifier": "site2",
        "CategoryName": "test",
        "Description": "",
        "LockDashboard": false,
        "LockDatasource": false,
        "UseSourceItemName": true,
        "Datasources": [
            {
            "Id": "518bb388-338a-4420-8b8a-581dc6bf2935",
            "IsLocked": false
            }
        ],
        "PublishType": "Internal"
        }
    ]
}

Response Schema

Name	Type
ApiStatus	Bool
Status	Bool
StatusMessage	String

Sample Response

{
    "ApiStatus": true,    
    "Status": true,
    "StatusMessage": "Dashboard is being published to one or more other sites.”
}

Note: The dashboard publish API can be performed only by the owner of dashboard or by “Admin” user.