API Reference

Read Table Dataset

GET/api/v2/datasets/{datasetRid}/readTable

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Gets the content of a dataset as a table in the specified format.

This endpoint currently does not support views (Virtual datasets composed of other datasets).

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:datasets-read.

Path parameters

datasetRid

string

The Resource Identifier (RID) of a Dataset.

Query parameters

branchName

string

optional

The name of the Branch.

startTransactionRid

string

optional

The Resource Identifier (RID) of the start Transaction.

endTransactionRid

string

optional

The Resource Identifier (RID) of the end Transaction.

format

string (enum)

The export format. Must be ARROW or CSV.

Enum values: ARROW, CSV

columns

list<string>

optional

A subset of the dataset columns to include in the result. Defaults to all columns.

rowLimit

integer

optional

A limit on the number of rows to return. Note that row ordering is non-deterministic.

preview

boolean

optional

Enables the use of preview functionality.

Response body

body

string

Examples

Request

Copied!

curl \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/readTable?branchName=master&startTransactionRid=ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4&endTransactionRid=ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4&format=CSV&columns=&rowLimit=&preview=true"