## 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 Parameters

- `dataset_id: string`

### Body Parameters

- `dataset: object { description, name, tags }  or RestoreRequest`

  - `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.

      - `true`

### Returns

- `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.

  - `created_by: Identity`

    The identity that created the entity.

    - `id: string`

    - `type: "user" or "service_account"`

      - `"user"`

      - `"service_account"`

    - `object: optional "identity"`

      - `"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.

  - `description: optional string`

  - `object: optional "dataset"`

    - `"dataset"`

### Example

```http
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"
          ]
        }'
```

#### Response

```json
{
  "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"
}
```