Создать доску
Запрос позволяет создать доску.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы создать доску, используйте HTTP-запрос с методом POST
. Параметры запроса передаются в его теле в формате JSON.
POST /v2/boards/
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
"name" : "Тестирование",
"defaultQueue": {
"id": 111,
"key": "test"
}
}
Заголовки
-
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 для бизнеса, используется заголовок
Параметры тела запроса
Тело запроса содержит параметры новой доски.
Обязательные параметры
Параметр | Описание | Тип данных |
---|---|---|
name | Название доски | Строка |
defaultQueue | Очередь | Может задаваться как объект, как строка (если передается ключ очереди), как число (если передается идентификатор очереди). |
Дополнительные параметры
Параметр | Описание | Тип данных |
---|---|---|
boardType | Тип доски. Возможные типы досок:
|
Строка |
filter | Объект с информацией об условиях фильтра, с помощью которого отбираются задачи для доски. Параметры задачи состоят из полей и значений. Группа параметров filter , orderBy и orderAsc несовместима с параметром query , который также описывает условия фильтра. |
Объект |
orderBy | Ключ поля. Поле служит параметром для сортировки задач на доске. Полный список полей: https://tracker.yandex.ru/admin/fields |
Строка |
orderAsc | Направление сортировки:
|
Логический |
query | Параметры фильтра, с помощью которого отбираются задачи для доски. Параметры задаются на языке запросов. Параметр query несовместим с группой параметров, которые также описывают условия фильтра: filter , orderBy и orderAsc . |
Строка |
useRanking | Возможность менять порядок задач на доске:
|
Логический |
country | Объект с информацией о стране. Данные производственного календаря страны используются в Диаграмме сгорания задач. Чтобы получить список стран, используйте HTTP-запрос: GET /v2/countries |
Объект |
Поля объекта defaultQueue
Параметр | Описание | Тип данных |
---|---|---|
id | Идентификатор очереди | Строка |
key | Ключ очереди | Строка |
Поля объекта filter
Параметр | Описание | Тип данных |
---|---|---|
<ключ_параметра_1> | Ключ поля, который является параметром отбора задач на доску. Полный список полей: https://tracker.yandex.ru/admin/fields |
Строка |
<ключ_параметра_2> | Массив с ключами полей, которые являются параметрами отбора задач на доску. Полный список полей: https://tracker.yandex.ru/admin/fields |
Массив |
Поля объекта country
Параметр | Описание | Тип данных |
---|---|---|
id | Идентификтор страны | Строка |
Пример 1: Создать доску с названием
Testing
. Фильтр задать через объектfilter
.
- Используется HTTP-метод
POST
.POST /v2/boards/ Host: api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации> { "name": "Testing", "boardType": "default", "defaultQueue": { "id": "111", "key": "test" }, "filter": { "assignee": "user1", "priority": [ "normal", "critical" ] }, "orderBy": "updated", "orderAsc": false, "useRanking": false, "country": { "id": "1" } }
Примечание
Если у вас только организация Yandex Cloud Organization, используйте заголовок
X-Cloud-Org-ID
, если только Яндекс 360 для бизнеса или оба типа организаций —X-Org-ID
.
Пример 2: Создать доску с названием
Testing
. Фильтр задать на языке запросов.
- Используется HTTP-метод
POST
.POST /v2/boards/ Host: api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации> { "name": "Testing", "boardType": "default", "defaultQueue": { "id": "111", "key": "test" }, "query": "assignee: user1 AND (priority: normal OR priority: critical)", "useRanking": false, "country": { "id": "1" } }
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK
.
Тело ответа содержит JSON-объект с параметрами новой доски.
{
"self": "https://api.tracker.yandex.net/v2/boards/1",
"id": 1,
"version": 1,
"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
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 422
- Ошибка валидации JSON, запрос отклонен.
- 500
- Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
- 503
- Сервис API временно недоступен.