Копировать дашборд

Запрос создает копию дашборда вместе с его виджетами и их раскладкой. Владельцем копии становится автор запроса.

POST

https://api.tracker.yandex.net/v3/dashboards/{id_дашборда}/_copy

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

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

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

{
  "name": "Копия планов команды"
}

Заголовки

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_дашборда	Идентификатор дашборда.	Число

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

Дополнительные параметры

Параметр	Описание	Тип данных
name	Название копии. Если параметр не передан, копия получает название исходного дашборда.	Строка

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

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

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

В случае успешного выполнения запроса 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 возвращает ответ с кодом ошибки:

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

Нет права READ на исходный дашборд.

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

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

Нельзя скопировать главную страницу — дашборд типа MAIN_PAGE.

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

Найти дашборды

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