## Update or restore a dataset

`client.datasets.update(stringdatasetID, DatasetUpdateParamsparams, RequestOptionsoptions?): 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.

### Parameters

- `datasetID: string`

- `params: DatasetUpdateParams`

  - `dataset: PartialDatasetRequestBase | RestoreRequest`

    - `PartialDatasetRequestBase`

      - `description?: string`

      - `name?: string`

      - `tags?: Array<string>`

        The tags associated with the entity

    - `RestoreRequest`

      - `restore: true`

        Set to true to restore the entity from the database.

        - `true`

### Returns

- `Dataset`

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

      - `"user"`

      - `"service_account"`

    - `object?: "identity"`

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

  - `description?: string`

  - `object?: "dataset"`

    - `"dataset"`

### Example

```typescript
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);
```

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