Reference

Endpoint Get a Workspace

Name

get_workspace

Description

Get a Workspace by ID. [API reference]

Related Tables

Workspaces

Parameters

Parameter Required Options
Name: Id

Label: Id

 YES

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_STR varchar(36) 36
Name DT_WSTR nvarchar(150) 150
Type DT_WSTR nvarchar(50) 50
IsReadOnly DT_BOOL bit
IsOnDedicatedCapacity DT_BOOL bit
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 Workspaces 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
Workspaces
Required Parameters
Id Fill-in the parameter...
SSIS API Source - Read from table or endpoint

API Destination

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

API Destination - Power BI
Connect to your Power BI account and retrieve data, refresh datasets, etc.
Power BI
Workspaces
Lookup
Required Parameters
Id Fill-in the parameter...
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Workspaces - Get a Workspace 

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

get_workspace endpoint belongs to Workspaces 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:

Workspaces - Get a Workspace 

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

EXEC (@MyQuery) AT [LS_TO_POWER_BI_IN_GATEWAY];

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