Tables - List Tables

Service:

Lakehouse

API Version:

v1

Note

This API is in preview.

Returns a list of lakehouse Tables.

This API supports pagination. A maximum of 100 records can be returned per request. With the URI provided in the response, you can get the next page of records.

Required Delegated Scopes

Lakehouse.Read.All or Lakehouse.ReadWrite.All

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses/{lakehouseId}/tables

With optional parameters:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses/{lakehouseId}/tables?maxResults={maxResults}&continuationToken={continuationToken}

URI Parameters

Name	In	Required	Type	Description
lakehouseId	path	True	string uuid	The lakehouse ID.
workspaceId	path	True	string uuid	The workspace ID.
continuationToken	query		string	Token to retrieve the next page of results, if available.
maxResults	query		integer int32	The maximum number of results per page to return.

Responses

Name	Type	Description
200 OK	Tables	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: UnknownError - An error occurred.

Examples

List tables example

Sample Request

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/lakehouses/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/tables?maxResults=10&continuationToken=

Sample Response

Status code:

200

{
  "continuationToken": "+RID:~HTsuAOseYicH-GcAAAAAAA==#RT:1#TRC:1#ISV:2#IEO:65567#QCF:8#FPC:AgKfAZ8BnwEEAAe8eoA=",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/lakehouses/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/tables?continuationToken=%2BRID%3A~HTsuAOseYicH-GcAAAAAAA%3D%3D%23RT%3A1%23TRC%3A1%23ISV%3A2%23IEO%3A65567%23QCF%3A8%23FPC%3AAgKfAZ8BnwEEAAe8eoA%3D",
  "data": [
    {
      "type": "Managed",
      "name": "Table1",
      "location": "abfss://f089354e-8366-4e18-aea3-4cb4a3a50b48@onelake.dfs.fabric.microsoft.com/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/Tables/Table1",
      "format": "Delta"
    }
  ]
}

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
Table	Table information.
Tables	A paginated list of tables.
TableType	The table type. Additional TableType types may be added over time.

ErrorRelatedResource

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

Table

Table information.

Name	Type	Description
format	string	Table format.
location	string	Table location.
name	string	Table name.
type	TableType	Table type.

Tables

A paginated list of tables.

Name	Type	Description
continuationToken	string	Token to get the next page of results.
continuationUri	string	The URI of the next chunk in the result set.
data	Table[]	List of tables.

TableType

The table type. Additional TableType types may be added over time.

Name	Type	Description
External	string	External table.
Managed	string	Managed table.