Search documentation
karat

+

K

User Documentation ↗

Get Dataset

GET/api/v2/datasets/{datasetRid}

Get the Dataset with the specified rid.

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.

Response body

Dataset
object
Hide child attributes

Hide child attributes

rid
string

The Resource Identifier (RID) of a Dataset.

name
string
parentFolderRid
string

The unique resource identifier (RID) of a Folder.

Examples

Request

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

Response

Copied!
1 2 3 4 5 { "parentFolderRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791", "name": "My Dataset", "rid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" }

Error responses

Error Name
DatasetNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe requested dataset could not be found, or the client token does not have access to it.
ParametersdatasetRid
ResourceNameAlreadyExistsError CodeCONFLICT
Status Code404
DescriptionThe provided resource name is already in use by another resource in the same folder.
ParametersparentFolderRid, displayName
DatasetNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given Dataset could not be found.
ParametersdatasetRid