Endpoint

Get a Dataset

Name

get_dataset

Description

Related Tables

Datasets

Parameters

Parameter	Label	Required	Options	Description
Id	Id	YES
WorkspaceId	WorkspaceId	NO

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_STR`	`varchar(36)`	36	`False`
Name	`DT_WSTR`	`nvarchar(150)`	150	`False`
WebUrl	`DT_WSTR`	`nvarchar(500)`	500	`False`
AddRowsAPIEnabled	`DT_BOOL`	`bit`		`False`
ConfiguredBy	`DT_WSTR`	`nvarchar(500)`	500	`False`
IsRefreshable	`DT_BOOL`	`bit`		`False`
IsEffectiveIdentityRequired	`DT_BOOL`	`bit`		`False`
IsEffectiveIdentityRolesRequired	`DT_BOOL`	`bit`		`False`
IsOnPremGatewayRequired	`DT_BOOL`	`bit`		`False`
TargetStorageMode	`DT_WSTR`	`nvarchar(50)`	50	`False`
CreatedDate	`DT_DBTIMESTAMP`	`datetime`		`False`
CreateReportEmbedURL	`DT_WSTR`	`nvarchar(1000)`	1000	`False`
QnaEmbedURL	`DT_WSTR`	`nvarchar(1000)`	1000	`False`
UpstreamDatasets	`DT_WSTR`	`nvarchar(50)`	50	`False`
Users	`DT_WSTR`	`nvarchar(50)`	50	`False`

If the column you are looking for is missing, consider customizing Power BI Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	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 component to read data or in API Destination component to read/write data:

Lookup a row in Datasets table using API Destination

This Endpoint belongs to Datasets table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Power BI

Datasets

Lookup

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get a dataset

SELECT * FROM get_dataset
WHERE Id = 'abcd-1234-id'

Datasets - Get a Dataset

SELECT * 
FROM Datasets
WHERE Id='aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'

get_dataset 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:

Get a dataset

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_dataset
WHERE Id = ''abcd-1234-id''';

EXEC (@MyQuery) AT [LS_TO_POWER_BI_IN_GATEWAY];

Datasets - Get a Dataset

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

EXEC (@MyQuery) AT [LS_TO_POWER_BI_IN_GATEWAY];

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