Редактировать колонку
Запрос позволяет изменить параметры колонки.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы изменить параметры колонки, используйте HTTP-запрос с методом PATCH
. Параметры запроса передаются в его теле в формате JSON.
PATCH /v2/boards/<идентификатор_доски>/columns/<идентификатор_колонки>
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 | Название колонки. | Строка |
statuses | Массив содержит ключи возможных статусов задач, которые попадут в колонку. Список всех статусов задачи: https://tracker.yandex.ru/admin/statuses |
Массив |
Пример: Изменить параметры колонки с идентификатором
1
на доске с идентификатором5
.
- Используется HTTP-метод
POST
.PATCH /v2/boards/5/columns/1 Host: api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации> If-Match: "<номер_версии>" { "name": "Согласовать", "statuses": [ "needInfo", "needAcceptance" ] }
Примечание
Если у вас только организация Yandex Cloud Organization, используйте заголовок
X-Cloud-Org-ID
, если только Яндекс 360 для бизнеса или оба типа организаций —X-Org-ID
.
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK
.
Тело ответа содержит JSON-объект со всеми параметрами колонки, включая измененные.
{
"self": "https://api.tracker.yandex.net/v2/boards/73/columns/5",
"id": 5,
"name": "Согласовать",
"statuses":
[
{
"self": "https://api.tracker.yandex.net/v2/statuses/2",
"id": "2",
"key": "needInfo",
"display": "Требуется информация"
},
...
]
}
Параметры ответа
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о колонке доски | Строка |
id | Идентификатор колонки | Число |
name | Название колонки | Строка |
statuses | Массив содержит информацию о статусах задач, которые находятся в колонке | Массив |
Поля объекта statuses
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о статусе. | Строка |
id | Идентификатор статуса. | Строка |
key | Ключ статуса. | Строка |
display | Отображаемое название статуса. | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 412
- При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.
- 422
- Ошибка валидации JSON, запрос отклонен.
- 428
- Доступ к ресурсу отклонен. Проверьте, указаны ли все обязательные условия выполнения запроса.
- 500
- Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
- 503
- Сервис API временно недоступен.