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