Создать резолюцию
Запрос позволяет создать новую резолюцию.
POST
https://api.tracker.yandex.net/v3/resolutions/
Для выполнения запроса требуются права администратора.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы создать резолюцию, используйте HTTP-запрос с методом POST. В теле запроса укажите параметры в формате JSON:
POST /v3/resolutions/
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
"key": "myResolution",
"name": {
"ru": "Моя резолюция",
"en": "My resolution"
}
}
Заголовки
-
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.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.
-
Параметры тела запроса
Тело запроса содержит информацию, необходимую для создания новой резолюции:
Обязательные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| key | Ключ (идентификатор) резолюции. Должен состоять из латинских букв и начинаться с маленькой буквы | Строка |
| name | Название резолюции | Объект |
Поля объекта name
| Параметр | Описание | Тип данных |
|---|---|---|
| ru | Название резолюции на русском | Строка |
| en | Название резолюции на английском | Строка |
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 201 Created.
Тело запроса содержит информацию о созданной резолюции в формате JSON.
{
"self": "https://api.tracker.yandex.net/v3/resolutions/9",
"id": 9,
"key": "myResolution",
"version": 1,
"name": "Моя резолюция",
"order": 90
}
Параметры ответа
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о резолюции | Строка |
| id | Уникальный идентификатор резолюции в Трекере | Число |
| key | Ключ резолюции | Строка |
| version | Версия резолюции | Число |
| name | Название резолюции | Строка |
| order | Вес резолюции. Параметр влияет на порядок отображения резолюции в интерфейсе | Число |
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 409
- При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.