Datasets - Get Gateway Datasources In Group

Service:

Power BI REST APIs

API Version:

v1.0

Returns a list of gateway data sources for the specified dataset from the specified workspace.

Important

This API call is deprecated, use Get Datasources In Group instead.

Required Scope

Dataset.ReadWrite.All or Dataset.Read.All

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/Default.GetBoundGatewayDatasources

URI Parameters

Name	In	Required	Type	Description
datasetId	path	True	string	The dataset ID
groupId	path	True	string uuid	The workspace ID

Responses

Name	Type	Description
200 OK	GatewayDatasources	OK

Examples

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/Default.GetBoundGatewayDatasources

Sample response

Status code:

200

{
  "value": [
    {
      "id": "16a54ccd-620d-4af3-9197-0b8c779a9a6d",
      "gatewayId": "7f1c4e55-544b-403f-b132-da0d3a024674",
      "datasourceType": "Sql",
      "connectionDetails": "{\"server\":\"MyServer.database.windows.net\",\"database\":\"MyDatabase\"}"
    }
  ]
}

Definitions

Name	Description
credentialType	The type of data source credential
GatewayDatasource	A Power BI gateway data source
GatewayDatasourceCredentialDetails	The data source credential details
GatewayDatasources	The OData response wrapper for a Power BI gateway data source collection

credentialType

The type of data source credential

Name	Type	Description
Anonymous	string
Basic	string
Key	string
OAuth2	string
SAS	string
Windows	string

GatewayDatasource

A Power BI gateway data source

Name	Type	Description
connectionDetails	string	Connection details in JSON format
credentialDetails	GatewayDatasourceCredentialDetails	The connection details for the data source that needs update. The connection details are mandatory when the dataset has more than one data source.
credentialType	credentialType	The type of data source credential
datasourceName	string	The name of the data source
datasourceType	string	The type of data source. API name for the data source ActiveDirectory AdobeAnalytics AdoDotNet AnalysisServices AzureBlobs AzureDataLakeStorage AzureMarketplace AzureTables BizTalk CDPA CustomConnector CustomHttpApi DB2 Essbase EventHub Excel Exchange Extension Facebook File Folder GoogleAnalytics Hdfs HDInsight Informix MQ MySql OData ODBC OleDb Oracle PostgreSql PowerQueryMashup PubNub Salesforce SAPBW SAPBWMessageServer SapErp SAPHana SharePoint SharePointDocLib SharePointList Sql Sybase Teradata UIFlow Web
gatewayId	string	The associated 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.
id	string	The unique ID for the data source

GatewayDatasourceCredentialDetails

The data source credential details

Name	Type	Description
useEndUserOAuth2Credentials	boolean	Whether the end-user Azure AD identity (OAuth 2.0 credentials) is used when connecting to the data source in DirectQuery mode. Use with data sources that support single sign-on (SSO).

GatewayDatasources

The OData response wrapper for a Power BI gateway data source collection

Name	Type	Description
odata.context	string	OData context
value	GatewayDatasource[]	The list of gateway data sources