EndPoint Get a Dataset
Name
get_dataset
Description
Get a Dataset by ID. [API reference]
Parameters
| Parameter | Label | Required | Options | Description |
|---|---|---|---|---|
| Id | Id | YES | ||
| WorkspaceId | WorkspaceId | NO |
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Raw | Description |
|---|---|---|---|---|---|
| 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 |
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:
Get a Dataset using API Source
Power BI
Get a Dataset
Get a Dataset using API Destination
Power BI
Get a Dataset
