Получить приоритеты
Статья создана
Обновлена 26 августа 2024 г.
Запрос позволяет получить список приоритетов для задачи.
Формат запроса
Перед выполнением запроса получите доступ к API.
Для получения списка приоритетов используйте HTTP-запрос с методом GET:
GET /v2/priorities
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки
-
Host
Адрес узла, предоставляющего API:
api.tracker.yandex.net -
Authorization
OAuth-токен в формате
OAuth <OAuth-токен>, например:OAuth 0c4181a7c2cf4521964a72ff******** -
X-Org-ID или X-Cloud-Org-ID
Идентификатор организации. Узнать его можно на странице организаций Tracker.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
X-Org-ID. - Если к Tracker привязана только организация Yandex Cloud Organization, используется заголовок
X-Cloud-Org-ID. - Если к Tracker одновременно привязаны организации Яндекс 360 для бизнеса и Yandex Cloud Organization, используется заголовок
X-Org-IDи идентификатор организации Яндекс 360 для бизнеса.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
Параметры запроса
Дополнительные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| localized | Признак наличия переводов в ответе. Допустимые значения:
|
Логический |
Запрос приоритетов:
- Используется HTTP-метод GET.
GET /v2/priorities?localized=false HTTP/1.1 Host: api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Формат ответа
Запрос выполнен успешно
Запрос выполнен с ошибкой
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.
Тело ответа содержит результаты в формате JSON.
[
{
"self": "https://api.tracker.yandex.net/v2/priorities/5",
"id": 5,
"key": "blocker",
"version": 1341632717561,
"name": "Блокер",
"order": 5
},
...
]
Параметры ответа
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о приоритете. | Строка |
| id | Идентификатор приоритета. | Число |
| key | Ключ приоритета. | Строка |
| version | Версия приоритета. | Число |
| name | Отображаемое название приоритета. При переданном в запросе localized=false данный параметр будет содержать дубликаты названия на других языках. |
Строка |
| order | Вес приоритета. Параметр влияет на порядок отображения приоритета в интерфейсе. | Число |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 401
- Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.