Get a dataset

client.datasets.retrieve(, ?, ?): Dataset { id, created_at, created_by, 6 more }

GET/v5/datasets/{dataset_id}

Retrieve a single dataset by its id.

By default an archived dataset is not returned; set include_archived to true to fetch a dataset regardless of whether it has been archived.

ParametersExpand Collapse

datasetID: string

query: DatasetRetrieveParams { include_archived }

include_archived?: boolean

ReturnsExpand Collapse

Dataset { id, created_at, created_by, 6 more }

id: string

The unique identifier of the entity.

created_at: string

The date and time when the entity was created in ISO format.

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" | "service_account"

One of the following:

"user"

"service_account"

object?: "identity"

current_version_num: number

name: string

tags: Array<string> | null

The tags associated with the entity

archived_at?: string

The date and time when the entity was archived in ISO format.

formatdate-time

description?: string

object?: "dataset"

Get a dataset

import SGPClient from 'scale-gp';

const client = new SGPClient({
  accountID: 'My Account ID',
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

const dataset = await client.datasets.retrieve('dataset_id');

console.log(dataset.id);

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "current_version_num": 0,
  "name": "name",
  "tags": [
    "string"
  ],
  "archived_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "object": "dataset"
}

Returns Examples

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "current_version_num": 0,
  "name": "name",
  "tags": [
    "string"
  ],
  "archived_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "object": "dataset"
}