Skip to content
sgp
API Reference
Datasets

Update or restore a dataset

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.

Path ParametersExpand Collapse
dataset_id: string
Body ParametersJSONExpand Collapse
dataset: object { description, name, tags } or RestoreRequest { restore }
One of the following:
PartialDatasetRequestBase object { description, name, tags }
description: optional string
name: optional string
tags: optional array of string

The tags associated with the entity

RestoreRequest object { restore }
restore: true

Set to true to restore the entity from the database.

ReturnsExpand Collapse
Dataset object { 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" or "service_account"
One of the following:
"user"
"service_account"
object: optional "identity"
current_version_num: number
name: string
tags: array of string

The tags associated with the entity

archived_at: optional string

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

formatdate-time
description: optional string
object: optional "dataset"

Update or restore a dataset

curl https://api.egp.scale.com/v5/datasets/$DATASET_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $SGP_API_KEY" \
    -d '{
          "description": "description",
          "name": "name",
          "tags": [
            "string"
          ]
        }'
{
  "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"
}