Skip to main content
GET
Get datasets

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer

Number of page. Starts from the first (1) page.

per_page
integer

Number of records to return.

q
string

Free-text keyword query matched against dataset name.

data_plane_id
string<uuid>

Narrow results to datasets on this data plane.

tag
string

Filter to datasets carrying this tag. When supplied multiple times, only datasets carrying every supplied tag are returned (all-of semantics).

mapping_source
enum<string>[]

Return only the dataset's mappings with one of these sources; the datasets themselves are not filtered. Repeat the parameter to name several; omitted, every stored mapping is returned. Naming derived adds the derived mappings the dataset's stored mappings imply, whatever their own source: each is computed on the request by applying a derivation rule to a stored mapping, has no id because nothing is stored, and carries a provenance saying how it was produced.

The source of the mapping.

  • company - Company private mapping
  • admin - Admin created/promoted mapping
  • system - System (Automated/ML) mappings
  • lineage - Lineage-derived mappings (editable without admin)
  • rosetta_stone - Rosetta Stone mappings (editable without admin)
  • derived - Computed on the request from a stored mapping and a derivation rule. Not stored, so it has no id; listed only when asked for by source
Available options:
company,
admin,
system,
lineage,
rosetta_stone,
derived

Response

OK

current_page
integer<int64>
required

The number of requested page.

Example:

1

total_records
integer<int64>
required

Total amount of accessible Access Rules

Example:

15000

total_pages
integer<int64>
required

Total amount of pages.

Example:

10

records
object[]
required
prev_page
integer<int64> | null

The number of the previous page, or null on the first page. Can also refer to the latest existing page if a page beyond the last one was requested.

Example:

1

next_page
integer<int64> | null

The number of the next page, or null on the last page.

Example:

42