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

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

  1. Формат запроса
  2. Формат ответа

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

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

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

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

https://api.tracker.yandex.net
Authorization

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

OAuth 0c4181a7c2cf4521964a72ff57a34a07
X-Org-ID

Идентификатор организации.

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

В случае успешного выполнения запроса API возвращает ответ с кодом 200. Тело ответа содержит JSON-массив с параметрами всех досок, созданных пользователями организации.

Тело ответа
[ 
  {
  "self" : "http://api.tracker.yandex.net/v2/boards/1",
  "id" : 1,
  "version" : 1412806202302,
  "name" : "Тестирование", 
  "columns" : 
  [ 
   {
    "self" : "http://api.tracker.yandex.net/v2/boards/1/columns/1387461731452",
    "id" : "1387461731452",
    "display" : "Открыт"
   },
    ...
  ],
  "filter": {
     "<ключ параметра 1>": "<значение 1>",
     "<ключ параметра 2>": [
          "<значение 2>", 
                         ...
        ],
         ...
     },
  "orderBy": "updated",
  "orderAsc": false,
  "query": "<Параметр 1>: <Значение 1> AND <Параметр 2>: <Значение 2> OR <Параметр 3>: <Значение 3>...",
  "useRanking": false,
  
  "country": {
       "self": "https://api.tracker.yandex.net/v2/countries/1",
       "id": "1",
       "display": "Россия"
        }
   },
  ...
]
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит параметры доски. Строка.
id Идентификатор доски. Число.
version Версия доски. Каждое изменение доски увеличивает номер версии. Число.
name Название доски. Строка.
columns Объект с информацией о колонках доски. Объект.
filter

Объект с информацией об условиях фильтра, с помощью которого отбираются задачи для доски.

Параметры задачи состоят из полей и значений.

 Объект.
orderBy

Ключ поля.

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

Полный список полей: https://tracker.yandex.ru/admin/fields

 Строка.
orderAsc Направление сортировки:
  • true — по возрастанию значений поля
  • false — по убыванию значений поля
 Логический.
query

Параметры фильтра, с помощью которого отбираются задачи для доски.

Параметры задаются на языке запросов.

 Строка.
useRanking Возможность менять порядок задач на доске:
  • true— разрешено
  • false— запрещено
 Логический.
country

Объект с информацией о стране. Данные производственного календаря страны используются в Диаграмме сгорания задач.

Чтобы получить список стран, используйте HTTP-запрос: GET /v2/countries		 Объект.
Поля объекта columns
self Адрес ресурса API, который содержит информацию о колонке доски. Строка.
id Идентификатор колонки. Строка.
display Отображаемое название колонки. Строка.
Поля объекта filter
<ключ параметра 1>

Ключ поля, который является параметром отбора задач на доску.

Полный список полей: https://tracker.yandex.ru/admin/fields

 Строка.
<ключ параметра 2>

Массив с ключами полей, которые являются параметрами отбора задач на доску.

Полный список полей: https://tracker.yandex.ru/admin/fields

 Массив.
Поля объекта country
self Адрес ресурса API, который содержит название страны. Строка.
id Идентификтор страны. Строка.
display Отображаемое название страны. Строка.
Параметр Описание Тип данных
self Адрес ресурса API, который содержит параметры доски. Строка.
id Идентификатор доски. Число.
version Версия доски. Каждое изменение доски увеличивает номер версии. Число.
name Название доски. Строка.
columns Объект с информацией о колонках доски. Объект.
filter

Объект с информацией об условиях фильтра, с помощью которого отбираются задачи для доски.

Параметры задачи состоят из полей и значений.

 Объект.
orderBy

Ключ поля.

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

Полный список полей: https://tracker.yandex.ru/admin/fields

 Строка.
orderAsc Направление сортировки:
  • true — по возрастанию значений поля
  • false — по убыванию значений поля
 Логический.
query

Параметры фильтра, с помощью которого отбираются задачи для доски.

Параметры задаются на языке запросов.

 Строка.
useRanking Возможность менять порядок задач на доске:
  • true— разрешено
  • false— запрещено
 Логический.
country

Объект с информацией о стране. Данные производственного календаря страны используются в Диаграмме сгорания задач.

Чтобы получить список стран, используйте HTTP-запрос: GET /v2/countries		 Объект.
Поля объекта columns
self Адрес ресурса API, который содержит информацию о колонке доски. Строка.
id Идентификатор колонки. Строка.
display Отображаемое название колонки. Строка.
Поля объекта filter
<ключ параметра 1>

Ключ поля, который является параметром отбора задач на доску.

Полный список полей: https://tracker.yandex.ru/admin/fields

 Строка.
<ключ параметра 2>

Массив с ключами полей, которые являются параметрами отбора задач на доску.

Полный список полей: https://tracker.yandex.ru/admin/fields

 Массив.
Поля объекта country
self Адрес ресурса API, который содержит название страны. Строка.
id Идентификтор страны. Строка.
display Отображаемое название страны. Строка.