Update or restore a dataset

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

PATCH/v5/datasets/{dataset_id}

Update a dataset’s fields, or restore a previously archived dataset.

The request body is a union discriminated by its contents: a body of {"restore": true} triggers a restore, and any other body is treated as a partial update of the dataset’s name, description, and tags. Restore clears archived_at on the dataset and cascades the un-archival to its items and versions; restoring a dataset that is not archived returns it unchanged. A partial update on an archived dataset fails, since archived datasets cannot be modified.

ParametersExpand Collapse

datasetID: string

params: DatasetUpdateParams { dataset }

dataset: PartialDatasetRequestBase { description, name, tags } | RestoreRequest { restore }

One of the following:

PartialDatasetRequestBase { description, name, tags }

description?: string

name?: string

tags?: Array<string>

The tags associated with the entity

RestoreRequest { restore }

restore: true

Set to true to restore the entity from the database.

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"

Update or restore 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.update('dataset_id', { dataset: {} });

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"
}