Получить список статусов
Запрос позволяет получить список статусов задач.
GET
https://api.tracker.yandex.net/v3/statuses
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы получить список статусов задач, используйте HTTP-запрос с методом GET
:
GET /v3/statuses
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.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.
-
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK
.
Тело ответа содержит JSON-объект со списком статусов задач.
[
{
"self": "https://api.tracker.yandex.net/v3/statuses/1",
"id": 1,
"version": 1,
"key": "open",
"name": "Открыт",
"description": "Открыт",
"order": 200,
"type": "new"
}
]
Параметры ответа
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о типе задачи. | Строка |
id | Уникальный идентификатор статуса задачи в Трекере. | Число |
version | Версия статуса задачи. | Число |
key | Ключ статуса задачи. | Строка |
name | Отображаемое название статуса задачи. | Строка |
description | Описание статуса задачи. | Строка |
order | Вес статуса. Параметр влияет на порядок отображения статуса в интерфейсе. | Число |
type | Тип статуса. Допустимые значения:
|
Строка |
- 401
- Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.