Endpoint

Get a Workspace

Name

get_workspace

Description

Get a Workspace by ID. [API reference]

Related Tables

Workspaces

Parameters

Parameter	Label	Required	Options	Description
Id	Id	YES

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`
Type	`DT_WSTR`	`nvarchar(50)`	50	`False`
IsReadOnly	`DT_BOOL`	`bit`		`False`
IsOnDedicatedCapacity	`DT_BOOL`	`bit`		`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 Workspaces table using API Destination

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

Power BI

Workspaces

Lookup

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get a workspace

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

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:

Get a workspace

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

EXEC (@MyQuery) AT [LS_TO_POWER_BI_IN_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).