Редактировать приоритет
Запрос позволяет внести изменения в приоритет.
Запрос не может изменить значок приоритета в интерфейсе Трекера.
PATCH
https://api.tracker.yandex.net/v3/priorities/<id_или_ключ_приоритета>?version=<версия_приоритета>
Для выполнения запроса требуются права администратора.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы отредактировать приоритет, используйте HTTP-запрос с методом PATCH. В теле запроса укажите параметры в формате JSON.
PATCH /v3/priorities/<id_или_ключ_приоритета>?version=<версия_приоритета>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
"name": {
"en": "English name",
"ru": "Название на русском"
},
"description": "Описание"
}
Чтобы узнать параметры приоритета, такие как id, key или version, выполните запрос «Получить список приоритетов».
Заголовки
-
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_или_ключ_приоритета | Уникальный идентификатор приоритета в Трекере или ключ приоритета. | Число или строка |
Параметры запроса
Дополнительные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| version | Версия приоритета. Изменения вносятся только в текущую версию приоритета. | Число |
Параметры тела запроса
Дополнительные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| name | Название приоритета | Объект |
| description | Описание приоритета | Строка |
Поля объекта name
| Параметр | Описание | Тип данных |
|---|---|---|
| en | Название приоритета на английском | Строка |
| ru | Название приоритета на русском | Строка |
Пример: Изменить название приоритета.
- Используется HTTP-метод PATCH.
- Редактируется приоритет с
key=one.- Новое название приоритета: «Низкий».
PATCH /v3/priorities/one?version=1 Host: api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации> { "name": { "en": "Low", "ru": "Низкий" }, "description": "Описание" }
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.
Тело ответа содержит информацию об отредактированном приоритете в формате JSON.
{
"self": "https://api.tracker.yandex.net/v3/priorities/6",
"id": 6,
"key": "one",
"version": 2,
"name": "Низкий",
"description": "Описание",
"order": 60
}
Параметры ответа
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о приоритете | Строка |
| id | Уникальный идентификатор приоритета в Трекере | Число |
| key | Ключ приоритета | Строка |
| version | Версия приоритета | Число |
| name | Название приоритета | Строка |
| description | Описание приоритета | Строка |
| order | Вес приоритета. Параметр влияет на порядок отображения приоритета в интерфейсе | Число |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 401
- Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 409
- При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.
- 423
- Редактирование объекта заблокировано. Возможно, превышено допустимое значение параметра
version— количество обновлений объекта. Максимальное значение версии составляет10100для роботов и11100для пользователей.