API Reference

Read Table

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

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 RID of the Dataset.

Query parameters

branchId

string

optional

The identifier (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.

Response body

body

string

The content stream.

Examples

Request

Copied!

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