Reports - Bind To Gateway

Reference

Service:: Power BI REST APIs

API Version:: v1.0

Binds the specified data source of the paginated report from My workspace to the specified gateway, optionally with a given data source ID. If you don't supply a specific data source ID, the data source will be bound to the first matching data source in the gateway.

Permissions

This API call can be called by a service principal profile.

Required Delegated Scopes

Report.ReadWrite.All or Report.Read.All

Limitations

Only supports on-premises data gateway

POST https://api.powerbi.com/v1.0/myorg/reports/{reportId}/Default.BindToGateway

URI Parameters

Name	In	Required	Type	Description
reportId	path	True	string uuid	The report ID

Request Body

Name	Required	Type	Description
bindDetails	True	RdlBindDetail[]	List of bind details
gatewayObjectId	True	string	The gateway ID. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster and is similar to the gateway cluster ID.

Responses

Name	Type	Description
200 OK		OK

Examples

Example

Sample request

POST https://api.powerbi.com/v1.0/myorg/reports/cfafbeb1-8037-4d0c-896e-a46fb27ff229/Default.BindToGateway

Request Body

{
  "gatewayObjectId": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
  "bindDetails": [
    {
      "dataSourceName": "DataSource1",
      "dataSourceObjectId": "dc2f2dac-e5e2-4c37-af76-2a0bc10f16cb"
    },
    {
      "dataSourceName": "DataSource2",
      "dataSourceObjectId": "3bfe5d33-ab7d-4d24-b0b5-e2bb8eb01cf5"
    }
  ]
}

Sample response

Status code:: 200

Definitions

Name	Description
RdlBindDetail	BindDetail for each data source in a paginated report
RdlBindToGatewayRequest	Paginated report bind data source to gateway request

RdlBindDetail

BindDetail for each data source in a paginated report

Name	Type	Description
dataSourceName	string	Name of the data source in the paginated report
dataSourceObjectId	string	The unique identifier for the data source in the gateway

RdlBindToGatewayRequest

Paginated report bind data source to gateway request

Name	Type	Description
bindDetails	RdlBindDetail[]	List of bind details
gatewayObjectId	string	The gateway ID. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster and is similar to the gateway cluster ID.

Share via