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

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

PATCH

https://api.tracker.yandex.net/v3/dashboards/{id_дашборда}?version=DASHBOARD_VERSION

Формат запроса

Перед выполнением запроса получите доступ к API. Версию получите в ответе на запрос Получить дашборд.

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
      }
    ]
  }
}

Заголовки

Host: адрес узла, предоставляющего API.
Authorization: токен для авторизации в одном из форматов:
- OAuth OAUTH_TOKEN при авторизации по протоколу OAuth 2.0. Читать подробнее
- Bearer IAM_TOKEN при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. Читать подробнее
Content-Type: формат тела запроса. Должен иметь значение application/json.
X-Org-ID или X-Cloud-Org-ID: идентификатор организации.
- если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок X-Org-ID,
- если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок X-Cloud-Org-ID.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс

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

Параметры запроса

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

Параметр	Описание	Тип данных
version	Текущая версия дашборда из ответа на запрос Получить дашборд.	Число

Параметры тела запроса

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

Параметр	Описание	Тип данных
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	Высота.	Число

Формат ответа

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

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

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

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

{
  "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"}
  ]
}

Параметры ответа

Параметр	Описание	Тип данных
id	Идентификатор дашборда.	Число
self	Адрес ресурса API с параметрами дашборда.	Строка
version	Версия дашборда. Получите ее в ответе на запрос получения дашборда.	Число
name	Название дашборда.	Строка
createdBy	Создатель дашборда. Поля объекта пользователя.	Объект
createdAt	Дата и время создания дашборда.	Строка
layout	Режим отображения виджетов.	Строка
widgets	Ссылки на виджеты дашборда. Если список пуст, поле отсутствует.	Массив объектов
temp	Признак временного дашборда.	Логический
owner	Владелец дашборда. Поля объекта пользователя.	Объект

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

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

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

400: Один или несколько параметров запроса имеют недопустимое значение.

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

403: У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.

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

404: Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.

412: При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.

422: Ошибка валидации JSON, запрос отклонен.

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

Была ли статья полезна?

Получить дашборд

Получить права доступа к дашборду