Редактировать доску
Запрос позволяет изменить параметры доски.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы изменить параметры доски, используйте HTTP-запрос с методом PATCH
. Параметры запроса передаются в его теле в формате JSON.
PATCH /v2/boards/<идентификатор_доски>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
If-Match: "<номер_версии>"
<новые_параметры_доски_в_формате_JSON>
Заголовки
-
Host
Адрес узла, предоставляющего API:
api.tracker.yandex.net
-
Authorization
OAuth-токен в формате
OAuth <OAuth-токен>
, например:OAuth 0c4181a7c2cf4521964a72ff********
-
X-Org-ID или X-Cloud-Org-ID
Идентификатор организации. Если у вас только организация Yandex Cloud Organization, используйте заголовок
X-Cloud-Org-ID
, если только Яндекс 360 для бизнеса или оба типа организаций —X-Org-ID
. -
If-Match
Номер текущей версии доски. При указании неактуальной версии доски в ответ на HTTP-запрос придет ответ с ошибкой
412 Precondition Failed
.
Ресурс
Параметр | Описание | Тип данных |
---|---|---|
<идентификатор_доски> | Идентификатор доски | Число |
Параметры тела запроса
Тело запроса содержит параметры доски, которые нужно изменить.
Дополнительные параметры
Параметр | Описание | Тип данных |
---|---|---|
name | Название доски. | Строка |
columns | Объект с информацией о новых колонках доски. | Объект |
filter | Объект с информацией об условиях фильтра, с помощью которого отбираются задачи для доски. Параметры задачи состоят из полей и значений. Группа параметров filter , orderBy и orderAsc несовместима с параметром query , который также описывает условия фильтра. |
Объект |
orderBy | Ключ поля. Поле служит параметром для сортировки задач на доске. Полный список полей: https://tracker.yandex.ru/admin/fields |
Строка |
orderAsc | Направление сортировки:
|
Логический |
query | Параметры фильтра, с помощью которого отбираются задачи для доски. Параметры задаются на языке запросов. Параметр query несовместим с группой параметров, которые также описывают условия фильтра: filter , orderBy и orderAsc . |
Строка |
useRanking | Возможность менять порядок задач на доске:
|
Логический |
country | Объект с информацией о стране. Данные производственного календаря страны используются в Диаграмме сгорания задач. Чтобы получить список стран, используйте HTTP-запрос: GET /v2/countries |
Объект |
Поля объекта columns
Параметр | Описание | Тип данных |
---|---|---|
id | Идентификатор колонки | Строка |
name | Название колонки | Строка |
statuses | Ключ статуса задач, которые попадут в колонку. Список всех статусов задачи: https://tracker.yandex.ru/admin/statuses |
Строка |
Поля объекта filter
Параметр | Описание | Тип данных |
---|---|---|
<ключ_параметра_1> | Ключ поля, который является параметром отбора задач на доску. Полный список полей: https://tracker.yandex.ru/admin/fields |
Строка |
<ключ_параметра_2> | Массив с ключами полей, которые являются параметрами отбора задач на доску. Полный список полей: https://tracker.yandex.ru/admin/fields |
Массив |
Поля объекта country
Параметр | Описание | Тип данных |
---|---|---|
id | Идентификтор страны | Строка |
Пример: Изменить параметры доски с идентификатором
5
.
- Используется HTTP-метод
PATCH
.PATCH /v2/boards/5 Host: api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-ID: <идентификатор_организации> If-Match: "<номер_версии>" { "name": "Testing new", "columns": [ { "id": "1", "name": "Открыт", "statuses": "open" }, { "id": "2", "name": "Закрыт", "statuses": "closed" } ], "filter": { "assignee": "user1", "priority": [ "normal", "blocker", "critical" ] }, "orderBy": "created", "orderAsc": true, "useRanking": true, "country": { "id": "1" } }
Формат ответа
В случае успешного выполнения запроса 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
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 412
- При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.
- 422
- Ошибка валидации JSON, запрос отклонен.
- 428
- Доступ к ресурсу отклонен. Проверьте, указаны ли все обязательные условия выполнения запроса.
- 500
- Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
- 503
- Сервис API временно недоступен.