Reference

Endpoint Get Datasets


Name

get_datasets

Description

Get Datasets from default or specified Workspace. If WorkspaceId parameter is not supplied, default Workspace will be used. [API reference]

Related Tables

Datasets

Parameters

Parameter Required Options
Name: WorkspaceId

Label: WorkspaceId

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_STR varchar(36) 36
Name DT_WSTR nvarchar(150) 150
WebUrl DT_WSTR nvarchar(500) 500
AddRowsAPIEnabled DT_BOOL bit
ConfiguredBy DT_WSTR nvarchar(500) 500
IsRefreshable DT_BOOL bit
IsEffectiveIdentityRequired DT_BOOL bit
IsEffectiveIdentityRolesRequired DT_BOOL bit
IsOnPremGatewayRequired DT_BOOL bit
TargetStorageMode DT_WSTR nvarchar(50) 50
CreatedDate DT_DBTIMESTAMP datetime
CreateReportEmbedURL DT_WSTR nvarchar(1000) 1000
QnaEmbedURL DT_WSTR nvarchar(1000) 1000
UpstreamDatasets DT_WSTR nvarchar(50) 50
Users DT_WSTR nvarchar(50) 50
If the column you are looking for is missing, consider customizing Power BI Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Power BI Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Datasets table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Power BI
Connect to your Power BI account and retrieve data, refresh datasets, etc.
Power BI
Datasets
Optional Parameters
WorkspaceId
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Datasets table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get datasets:

API Destination - Power BI
Connect to your Power BI account and retrieve data, refresh datasets, etc.
Power BI
Datasets
Select
Optional Parameters
WorkspaceId
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Datasets - Get Datasets

SELECT * 
FROM Datasets

Datasets - Get Datasets in a specified Workspace

SELECT * 
FROM Datasets
WITH (WorkspaceId = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee')

get_datasets endpoint belongs to Datasets table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Datasets - Get Datasets

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * 
FROM Datasets';

EXEC (@MyQuery) AT [LS_TO_POWER_BI_IN_GATEWAY];

Datasets - Get Datasets in a specified Workspace

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * 
FROM Datasets
WITH (WorkspaceId = ''aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'')';

EXEC (@MyQuery) AT [LS_TO_POWER_BI_IN_GATEWAY];

get_datasets endpoint belongs to Datasets table(s), and can therefore be used via those table(s).