Получить параметры доски

Запрос позволяет получить параметры доски.

GET

https://api.tracker.yandex.net/v3/boards/<id_доски>

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

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

Чтобы получить параметры конкретной доски задач, используйте HTTP-запрос с методом GET.

GET /v3/boards/<id_доски>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки

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

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

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

    • Используйте заголовок X-Cloud-Org-ID, если к Трекеру привязана организация Yandex Cloud Organization.

    Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс
Параметр Описание Тип данных
<id_доски> Идентификатор доски Число

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

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

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

{
  "self": "https://api.tracker.yandex.net/v3/boards/1",
  "id" : 1,
  "version" : 1412806202302,
  "name" : "My board",
  "columns" :
  [
   {
    "self": "https://api.tracker.yandex.net/v3/boards/1/columns/13874********",
    "id" : "13874********",
    "display" : "Открыт"
   },
   ...
  ],
   "filter": {
      "<ключ_параметра_1>": "<значение_1>",
      "<ключ_параметра_2>": [
          "<значение_2>",
                        ...
       ],
        ...
    },
   "orderBy": "updated",
   "orderAsc": false,
   "query": "<параметр_1>: <значение_1> AND <параметр_2>: <значение_2> OR <параметр_3>: <значение_3>...",
   "useRanking": false,
   "estimateBy": {
      "self": "https://api.tracker.yandex.net/v3/fields/storyPoints",
      "id": "storyPoints",
      "display": "Story Points"
    }, 
   "country": {
      "self": "https://api.tracker.yandex.net/v3/countries/1",
      "id": "1",
      "display": "Russia"
    },
   "defaultQueue": {
      "self": "https://api.tracker.yandex.net/v3/queues/DOC",
      "id": "3",
      "key": "DOC",
      "display": "Documents"
    },
    "calendar": {
       "id": 6
      }
   }
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит параметры доски. Строка
id Идентификатор доски. Число
version Версия доски. Каждое изменение доски увеличивает номер версии. Число
name Название доски. Строка
columns Объект с информацией о колонках доски. Объект
filter Объект с информацией об условиях фильтра, с помощью которого отбираются задачи для доски.
Параметры задачи состоят из полей и значений.		 Объект
orderBy Ключ поля.
Поле служит параметром для сортировки задач на доске.
Полный список полей: https://tracker.yandex.ru/admin/fields		 Строка
orderAsc Направление сортировки:
  • true — по возрастанию значений поля;
  • false — по убыванию значений поля.
 Логический
query Параметры фильтра, с помощью которого отбираются задачи для доски.
Параметры задаются на языке запросов.		 Строка
useRanking Возможность менять порядок задач на доске:
  • true— разрешено;
  • false— запрещено.
 Объект
estimateBy Объект с информацией о том, по какому параметру оцениваются задачи на доске.
По умолчанию Story Points.		 Объект
country Объект с информацией о стране. Данные производственного календаря страны используются в Диаграмме сгорания задач.
Чтобы получить список стран, используйте HTTP-запрос: GET /v3/countries		 Объект
defaultQueue Объект с информацией об очереди, в которой задачи создаются по умолчанию. Объект
calendar Объект с информацией о производственном календаре для этой доски. Календарь используется для расчета рабочих и нерабочих дней в Диаграмме сгорания задач. Число

Поля объекта columns

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о колонке доски Строка
id Идентификатор колонки Строка
display Отображаемое название колонки Строка

Поля объекта filter

Параметр Описание Тип данных
<ключ_параметра_1> Ключ поля, который является параметром отбора задач на доску.
Полный список полей: https://tracker.yandex.ru/admin/fields		 Строка
<ключ_параметра_2> Массив с ключами полей, которые являются параметрами отбора задач на доску.
Полный список полей: https://tracker.yandex.ru/admin/fields		 Массив

Поля объекта estimateBy

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о параметре оценки задачи Строка
id Идентификатор параметра оценки задачи Строка
display Отображаемое название параметра оценки задачи Строка

Поля объекта country

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

Поля объекта defaultQueue

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию об очереди Строка
id Идентификатор очереди Строка
key Ключ очереди Строка
display Отображаемое название очереди Строка

Поля объекта calendar

Параметр Описание Тип данных
id Идентификатор календаря Число

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

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