Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get View

GET/api/v2/datasets/views/{viewDatasetRid}
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.

Get metadata for a View.

Path parameters

viewDatasetRid
string

The rid of the View.

Query parameters

branch
string
optional

The name of a Branch.

preview
boolean
optional

Enables the use of preview functionality.

Response body

View
object
Hide child attributes

Hide child attributes

viewName
string
datasetRid
string

The rid of the View.

parentFolderRid
string

The unique resource identifier (RID) of a Folder.

branch
string
optional

The branch name of the View. If not specified, defaults to master for most enrollments.

backingDatasets
list<ViewBackingDataset>
optional
Show child attributes

Show child attributes

primaryKey
object
optional

The primary key of the dataset. Primary keys are treated as guarantees provided by the creator of the dataset.

Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/datasets/views/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da?branch=master&preview=true"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 { "datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da", "parentFolderRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791", "viewName": "My Dataset", "backingDatasets": [ { "datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da", "branch": "master" } ], "branch": "master", "primaryKey": { "columns": [ "order_id" ] } }

Error responses

Error Name
ViewNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe requested View could not be found. Either the view does not exist, the branch is not valid or the client token does not have access to it.
ParametersviewDatasetRid, branch