Получить параметры колонки

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

GET

https://api.tracker.yandex.net/v3/boards/<id_доски>/columns/<id_колонки>

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

Перед выполнением запроса получите доступ к API.

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

GET /v3/boards/<id_доски>/columns/<id_колонки>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки

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

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

    • Используйте заголовок X-Org-ID, если к Трекеру привязана организация Яндекс 360 для бизнеса.

    • Используйте заголовок X-Cloud-Org-ID, если к Трекеру привязана организация Yandex Cloud Organization.

    Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс
Параметр Описание Тип данных
<id_доски> Идентификатор доски Число
<id_колонки> Идентификатор колонки Число

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

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

Тело ответа содержит JSON-объект с параметрами колонки.

{
    "self": "https://api.tracker.yandex.net/v3/boards/73/columns/1",
    "id": 1,
    "name": "Открыт",
    "statuses":
      [
         {
            "self": "https://api.tracker.yandex.net/v3/statuses/1",
            "id": "1",
            "key": "open",
            "display": "Открыт"
         },
          ...
      ]
}
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о колонке доски. Строка
id Идентификатор колонки. Число
name Название колонки. Строка
statuses Массив содержит ключи возможных статусов задач, которые попадут в колонку.
Список всех статусов задачи: https://tracker.yandex.ru/admin/statuses		 Массив.

Поля объекта statuses

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

Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

400
Один или несколько параметров запроса имеют недопустимое значение.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503
Сервис API временно недоступен.
Предыдущая
Получить параметры всех колонок
Следующая
Создать колонку