Редактировать колонку

Запрос позволяет изменить параметры колонки.

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

Чтобы изменить параметры колонки, используйте HTTP-запрос с методом PATCH:

PATCH /v2/boards/<board-id>/columns/<column-id>
Host: https://api.tracker.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>
If-Match: "<номер версии>"

{
  "name": "Согласовать",
  "statuses": 
      [
        "needInfo", "adjustment",...
      ]
}

Ресурс

<board-id>: Идентификатор доски.
<column-id>: Идентификатор колонки.

Заголовки

Host

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

https://api.tracker.yandex.net

Authorization

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

OAuth 0c4181a7c2cf4521964a72ff57a34a07

X-Org-ID: Идентификатор организации.
If-Match: Номер текущей версии доски. При указании неактуальной версии доски в ответ на HTTP-запрос придет ответ с ошибкой 412 Precondition Failed.

Тело запроса

Тело запроса содержит параметры колонки, которые нужно изменить.


Параметр	Описание	Тип данных
`name`	Название колонки.	Строка.
`statuses`	Массив содержит ключи возможных статусов задач, которые попадут в колонку. Список всех статусов задачи: https://tracker.yandex.ru/admin/statuses	Массив.


Параметр	Описание	Тип данных
`name`	Название колонки.	Строка.
`statuses`	Массив содержит ключи возможных статусов задач, которые попадут в колонку. Список всех статусов задачи: https://tracker.yandex.ru/admin/statuses	Массив.

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

В случае успешного выполнения запроса API возвращает ответ с кодом 200. Тело ответа содержит 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`	Отображаемое название статуса.	Строка.


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

Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:


HTTP-код ошибки	Описание ошибки
`400 Bad Request`	Один из параметров запроса имеет недопустимое значение или формат данных.
`403 Forbidden`	У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
`404 Not Found`	Запрашиваемый ресурс не найден.
`412 Precondition Failed`	Некорректное значение заголовка.
`422 Unprocessable Entity`	Ошибка валидации JSON, запрос отклонен.
`428 Precondition Required`	Требуется заголовок.
`500 Internal Server Error`	Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
`503 Service Unavailable`	Сервис API временно недоступен.


HTTP-код ошибки	Описание ошибки
`400 Bad Request`	Один из параметров запроса имеет недопустимое значение или формат данных.
`403 Forbidden`	У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
`404 Not Found`	Запрашиваемый ресурс не найден.
`412 Precondition Failed`	Некорректное значение заголовка.
`422 Unprocessable Entity`	Ошибка валидации JSON, запрос отклонен.
`428 Precondition Required`	Требуется заголовок.
`500 Internal Server Error`	Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
`503 Service Unavailable`	Сервис API временно недоступен.