## Update or restore a rubric

`client.rubrics.update(stringrubricID, RubricUpdateParamsparams, RequestOptionsoptions?): RubricResponse`

**patch** `/v5/rubrics/{rubric_id}`

Update a rubric's fields, or restore a previously archived rubric.

The request body is a discriminated union. Send `{"restore": true}` to restore
an archived rubric (clearing its archived state); send any other field set
(such as `title` or `tags`) to update those fields, carrying forward any field
not supplied. Both paths are append-only and produce a new version of the
rubric rather than mutating the existing row. Updating the fields of an
archived rubric is rejected — restore it first. Restoring a rubric that is not
archived is a no-op that returns it unchanged without creating a new version.

### Parameters

- `rubricID: string`

- `params: RubricUpdateParams`

  - `rubric: PartialRubricRequestBase | RestoreRequest`

    - `PartialRubricRequestBase`

      - `tags?: Array<string>`

        The tags associated with the entity

      - `title?: string`

        The rubric title

    - `RestoreRequest`

      - `restore: true`

        Set to true to restore the entity from the database.

        - `true`

### Returns

- `RubricResponse`

  - `id: string`

  - `created_at: string`

  - `created_by: Identity`

    The identity that created the entity.

    - `id: string`

    - `type: "user" | "service_account"`

      - `"user"`

      - `"service_account"`

    - `object?: "identity"`

      - `"identity"`

  - `tags: Array<string> | null`

    The tags associated with the entity

  - `title: string`

  - `version: number`

  - `archived_at?: string`

  - `criteria?: Array<RubricCriteriaResponse | RubricCriteriaSummaryResponse>`

    Full criteria on get, summary (title + weight) on list

    - `RubricCriteriaResponse`

      - `id: string`

      - `created_at: string`

      - `rubric_id: string`

      - `title: string`

      - `version: number`

      - `annotations?: Record<string, unknown>`

      - `object?: "rubric_criteria"`

        - `"rubric_criteria"`

      - `weight?: number`

    - `RubricCriteriaSummaryResponse`

      Slim criteria projection for list endpoints (title + weight only).

      - `title: string`

      - `weight?: number`

  - `object?: "rubric"`

    - `"rubric"`

  - `updated_at?: string`

### 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 rubricResponse = await client.rubrics.update('rubric_id', { rubric: {} });

console.log(rubricResponse.id);
```

#### Response

```json
{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "tags": [
    "string"
  ],
  "title": "title",
  "version": 0,
  "archived_at": "2019-12-27T18:11:19.117Z",
  "criteria": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "rubric_id": "rubric_id",
      "title": "title",
      "version": 0,
      "annotations": {
        "foo": "bar"
      },
      "object": "rubric_criteria",
      "weight": 0
    }
  ],
  "object": "rubric",
  "updated_at": "2019-12-27T18:11:19.117Z"
}
```