Связаться с намиПодключиться

Создать дашборд

Статья создана
Обновлена 26 августа 2024 г.

Запрос позволяет создать дашборд. Чтобы добавить виджет «Время цикла», используйте запрос Создать виджет «Время цикла».

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

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

Чтобы создать дашборд, используйте HTTP-запрос с методом POST. Параметры запроса передаются в его теле в формате JSON.

POST /v2/dashboards/
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
    "name": "<название_дашборда>",
    "layout": "<режим_отображения_виджетов>>",
    "owner": {
       "id": "<логин_или_идентификатор_пользователя>"
       }
}
Заголовки

  • Host

    Адрес узла, предоставляющего API:

    api.tracker.yandex.net

  • Authorization

    OAuth-токен в формате OAuth <OAuth-токен>, например:

    OAuth 0c4181a7c2cf4521964a72ff********

  • X-Org-ID или X-Cloud-Org-ID

    Идентификатор организации. Узнать его можно на странице организаций Tracker.

    • Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок X-Org-ID.
    • Если к Tracker привязана только организация Yandex Cloud Organization, используется заголовок X-Cloud-Org-ID.
    • Если к Tracker одновременно привязаны организации Яндекс 360 для бизнеса и Yandex Cloud Organization, используется заголовок X-Org-ID и идентификатор организации Яндекс 360 для бизнеса.
Параметры тела запроса

Тело запроса содержит параметры дашборда.

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

Параметр Описание Тип данных
name Название дашборда. Строка

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

Параметр Описание Тип данных
layout Режим отображения виджетов на дашборде.
Возможные режимы:
  • one-column — одна колонка — режим по умолчанию;
  • two-columns— две колонки;
  • three-columns— три колонки;
  • narrow-left-wide-right — узкая колонка слева и широкая справа;
  • one-top-two-bottom— одна колонка сверху и две снизу.
 Строка
owner Логин или идентификатор владельца дашборда. Если параметр не указан, владельцем становится создатель дашборда. Строка

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

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

Тело ответа содержит JSON-объект с параметрами нового дашборда.

{
   "id": 10,
   "version": 1,
   "name": "New Dashboard",
   "createdBy": {
      "self": "https://api.tracker.yandex.net/v2/users/44********",
      "id": "44********",
      "display": "Иван Иванов",
      "passportUid": 12********
   },
   "createdAt": "2024-04-15T19:38:42.074+0000",
   "layout": "one-column",
   "owner": {
      "self": "https://api.tracker.yandex.nett/v2/users/44********",
      "id": "44********",
      "display": "Иван Иванов",
      "passportUid": 12********
   },
   "self": "https://api.tracker.yandex.net/v2/dashboards/10"
}
Параметры ответа
Параметр Описание Тип данных
id Идентификатор дашборда. Число
version Версия дашборда. Каждое изменение дашборда увеличивает номер версии. Число
name Название дашборда. Строка
createdBy Объект с информацией о создателе дашборда. Объект
createdAt Дата и время создания дашборда в формате: YYYY-MM-DDThh:mm:ss.sss±hhmm. Строка
layout Режим отображения виджетов на дашборде. Строка
owner Объект с информацией о владельце дашборда. Объект
self Адрес ресурса API, который содержит параметры дашборда. Строка

Поля объекта createdBy и owner

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Строка
display Отображаемое имя пользователя. Строка
passportUid Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. Число

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

400
Один или несколько параметров запроса имеют недопустимое значение.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
422
Ошибка валидации JSON, запрос отклонен.
500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503
Сервис API временно недоступен.
Предыдущая
Создать спринт
Следующая
Создать виджет