---
metadata:
  - name: generator
    content: Diplodoc Platform v5.66.1
  - property: og:type
    content: article
  - property: article:section
    content: Справочник API
  - property: og:title
    content: Обновить дашборд
alternate:
  - https://yandex.ru/support/tracker/en/api/dashboards/update-dashboard.md
  - https://yandex.ru/support/tracker/ru/api/dashboards/update-dashboard.md
  - href: https://yandex.ru/support/tracker/ru/api/dashboards/update-dashboard.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.ru/support/tracker/ru/llms.txt?revision=r22057024
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/ru/llms.txt?revision=r22057024


# Обновить дашборд

Запрос изменяет параметры дашборда и расположение виджетов на нем.

<div class="request_example yfm-code-floating-container method_patch">
    <p>PATCH</p>
    <pre><code>https://api.tracker.yandex.net/v3/dashboards/{id_дашборда}?version=DASHBOARD_VERSION</code></pre>
    <button class="yfm-clipboard-button"><svg width="16" height="16" viewBox="0 0 24 24" class="yfm-clipboard-icon" data-animation="15">
    <path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path>
    <path stroke="currentColor" fill="transparent" strokewidth="1.5" d="M9.5 13l3 3l5 -5" visibility="hidden">
        <animate id="visibileAnimation-15" attributeName="visibility" from="hidden" to="visible" dur="0.2s" fill="freeze" begin=""></animate>
        <animate id="hideAnimation-15" attributeName="visibility" from="visible" to="hidden" dur="1s" begin="visibileAnimation-15.end+1" fill="freeze"></animate>
    </path>
</svg>
</button>
</div>

<!-- source: ru/api/_assets/style/methods.md -->

<!-- endsource: ru/api/_assets/style/methods.md -->

## Формат запроса {#request}

Перед выполнением запроса [получите доступ к API](https://yandex.ru/support/tracker/ru/api/access.md). Версию получите в ответе на запрос [Получить дашборд](https://yandex.ru/support/tracker/ru/api/dashboards/get-dashboard.md).

```json translate=no
PATCH /v3/dashboards/{id_дашборда}?version=DASHBOARD_VERSION
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
Content-Type: application/json
X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ

{
  "name": "Планы команды",
  "widgets": {
    "set": [
      {
        "id": 456,
        "column": 1,
        "row": 1,
        "collapsed": false,
        "coords": {"x": 0, "y": 0, "w": 6, "h": 8},
        "order": 1
      }
    ]
  }
}
```

<!-- source: ru/api/_includes/headings.md -->
{% cut "Заголовки" %}

* `Host`: адрес узла, предоставляющего API.

* <!-- source: ru/api/_includes/authorization.md -->
  `Authorization`: токен для авторизации в одном из форматов:

    - `OAuth OAUTH_TOKEN` при авторизации по протоколу OAuth 2.0. [Читать подробнее](https://yandex.ru/support/tracker/ru/api/access.md#about_OAuth)

    - `Bearer IAM_TOKEN` при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. [Читать подробнее](https://yandex.ru/support/tracker/ru/api/access.md#iam-token)
  <!-- endsource: ru/api/_includes/authorization.md -->

* <!-- source: ru/api/_includes/content-type-json.md -->
  `Content-Type`: формат тела запроса. Должен иметь значение `application/json`.
  <!-- endsource: ru/api/_includes/content-type-json.md -->


* <!-- source: ru/api/_includes/org-id.md -->
  `X-Org-ID` или `X-Cloud-Org-ID`: идентификатор организации.

  - если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок `X-Org-ID`,

  - если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок `X-Cloud-Org-ID`.
  <!-- endsource: ru/api/_includes/org-id.md -->

  <!-- source: ru/api/_includes/org-id.md -->
  Чтобы узнать идентификатор организации, перейдите на страницу **Администрирование** → [**Организации**](https://tracker.yandex.ru/admin/orgs) и скопируйте значение поля **идентификатор**.
  <!-- endsource: ru/api/_includes/org-id.md -->


{% endcut %}
<!-- endsource: ru/api/_includes/headings.md -->

{% cut "Ресурс" %}

#|
|| **Параметр** | **Описание** | **Тип данных** ||
|| id_дашборда | Идентификатор дашборда. | Число ||
|#

{% endcut %}

{% cut "Параметры запроса" %}

**Обязательные параметры**

#|
|| **Параметр** | **Описание** | **Тип данных** ||
|| version | Текущая версия дашборда из ответа на запрос [Получить дашборд](https://yandex.ru/support/tracker/ru/api/dashboards/get-dashboard.md). | Число ||
|#

{% endcut %}

{% cut "Параметры тела запроса" %}

Передайте параметры дашборда, которые нужно изменить.

#|
|| **Параметр** | **Описание** | **Тип данных** ||
|| name | Новое название дашборда. | Строка ||
|| widgets | Операция над набором виджетов. | Объект ||
|#

**Поля объекта** `widgets`

#|
|| **Параметр** | **Описание** | **Тип данных** ||
|| add | Добавляет существующие виджеты этого дашборда в раскладку. | Массив объектов ||
|| set | Заменяет весь набор виджетов. Виджеты, не включенные в новый набор, удаляются. | Массив объектов ||
|| remove | Удаляет указанные виджеты с дашборда. Удаленные виджеты становятся недоступны через API. | Массив объектов ||
|| replace | Заменяет параметры виджетов. В каждом элементе передайте объекты `target` и `replacement`. | Массив объектов ||
|#

На дашборде может быть не больше 100 виджетов. `column` и `row` передавайте только вместе, `coords` и `order` — также только вместе. Нумерация колонок и строк начинается с 1. Максимальное значение `column` зависит от раскладки: `one-column` — 1, `two-columns` — 2, `three-columns` — 3, `narrow-left-wide-right` — 2, `one-top-two-bottom` — 3. Ширина сетки для `coords` — 36.

**Поля элементов массива** `widgets.add`

Поля `id`, `column` и `row` обязательны.

#|
|| **Параметр** | **Описание** | **Тип данных** ||
|| id | Идентификатор виджета. | Число ||
|| column | Номер колонки. | Число ||
|| row | Номер строки. | Число ||
|| collapsed | Признак свернутого виджета. | Логический ||
|| coords | Координаты и размер виджета. | Объект ||
|| order | Порядок виджета. | Число ||
|#

**Поля элементов массива** `widgets.remove`

#|
|| **Параметр** | **Описание** | **Тип данных** ||
|| id | Идентификатор виджета. | Число ||
|#

**Поля элементов массива** `widgets.replace`

#|
|| **Параметр** | **Описание** | **Тип данных** ||
|| target | Виджет, параметры которого нужно заменить. Передайте объект с полем `id`. | Объект ||
|| replacement | Новые параметры раскладки виджета. Поля совпадают с полями элементов `widgets.set`. | Объект ||
|#

**Поля элементов массива** `widgets.set`

#|
|| **Параметр** | **Описание** | **Тип данных** ||
|| id | Идентификатор виджета. | Число ||
|| column | Номер колонки. | Число ||
|| row | Номер строки. | Число ||
|| collapsed | Признак свернутого виджета. | Логический ||
|| coords | Координаты и размер виджета. | Объект ||
|| order | Порядок виджета. | Число ||
|#

**Поля объекта** `coords`

#|
|| **Параметр** | **Описание** | **Тип данных** ||
|| x | Координата по горизонтали. | Число ||
|| y | Координата по вертикали. | Число ||
|| w | Ширина. | Число ||
|| h | Высота. | Число ||
|#

{% endcut %}

## Формат ответа {#response}

{% list tabs %}

- Запрос выполнен успешно

    <!-- source: ru/api/_includes/answer-200.md -->
    В случае успешного выполнения запроса API возвращает ответ с кодом `200 OK`.
    <!-- endsource: ru/api/_includes/answer-200.md -->

    При успехе API возвращает обновленный объект дашборда.

    ```json translate=no
    {
      "id": 123,
      "self": "https://api.tracker.yandex.net/v3/dashboards/123",
      "version": 4,
      "name": "Планы команды",
      "layout": "one-column",
      "widgets": [
        {"id": "456", "self": "https://api.tracker.yandex.net/v3/widgets/456"}
      ]
    }
    ```

    {% cut "Параметры ответа" %}

    #|
    || **Параметр** | **Описание** | **Тип данных** ||
    || id | Идентификатор дашборда. | Число ||
    || self | Адрес ресурса API с параметрами дашборда. | Строка ||
    || version | Версия дашборда. Получите ее в ответе на запрос [получения дашборда](https://yandex.ru/support/tracker/ru/api/dashboards/get-dashboard.md). | Число ||
    || name | Название дашборда. | Строка ||
    || createdBy | Создатель дашборда. [Поля объекта пользователя](https://yandex.ru/support/tracker/ru/api/dashboards/create-dashboard.md#user). | Объект ||
    || createdAt | Дата и время создания дашборда. | Строка ||
    || layout | Режим отображения виджетов. | Строка ||
    || widgets | Ссылки на виджеты дашборда. Если список пуст, поле отсутствует. | Массив объектов ||
    || temp | Признак временного дашборда. | Логический ||
    || owner | Владелец дашборда. [Поля объекта пользователя](https://yandex.ru/support/tracker/ru/api/dashboards/create-dashboard.md#user). | Объект ||
    |#

    **Поля элементов массива** `widgets`

    #|
    || **Параметр** | **Описание** | **Тип данных** ||
    || id | Идентификатор виджета. | Строка ||
    || self | Адрес ресурса API с параметрами виджета. | Строка ||
    || display | Название виджета. | Строка ||
    |#

    {% endcut %}

- Запрос выполнен с ошибкой

    Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

    <!-- source: ru/api/_includes/answer-error-400.md -->
    400
    :   Один или несколько параметров запроса имеют недопустимое значение.
    <!-- endsource: ru/api/_includes/answer-error-400.md -->

    Не указан обязательный параметр `version`.

    <!-- source: ru/api/_includes/answer-error-403.md -->
    403
    :   У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
    <!-- endsource: ru/api/_includes/answer-error-403.md -->

    Нет права `WRITE` на дашборд.

    <!-- source: ru/api/_includes/answer-error-404.md -->
    404
    :   Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
    <!-- endsource: ru/api/_includes/answer-error-404.md -->

    <!-- source: ru/api/_includes/answer-error-412.md -->
    412
    :   При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений. 
    <!-- endsource: ru/api/_includes/answer-error-412.md -->

    <!-- source: ru/api/_includes/answer-error-422.md -->
    422 
    :   Ошибка валидации JSON, запрос отклонен.
    <!-- endsource: ru/api/_includes/answer-error-422.md -->

    В `widgets` указан несуществующий виджет.

{% endlist %}