Получить параметры всех досок
Статья создана
Обновлена 26 августа 2024 г.
Запрос позволяет получить параметры всех досок задач, созданных пользователями организации.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы получить параметры всех досок задач, используйте HTTP-запрос с методом GET.
GET /v2/boards
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-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 для бизнеса.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
Формат ответа
Запрос выполнен успешно
Запрос выполнен с ошибкой
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.
Тело ответа содержит JSON-массив с параметрами всех досок, созданных пользователями организации.
[
{
"self" : "https://api.tracker.yandex.net/v2/boards/1",
"id" : 1,
"version" : 1412806202302,
"name" : "Тестирование",
"columns" :
[
{
"self" : "https://api.tracker.yandex.net/v2/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,
"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 | Направление сортировки:
|
Логический |
| query | Параметры фильтра, с помощью которого отбираются задачи для доски. Параметры задаются на языке запросов. |
Строка |
| useRanking | Возможность менять порядок задач на доске:
|
Логический |
| 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 | Отображаемое название страны | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 500
- Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
- 503
- Сервис API временно недоступен.