Создать компонент

Запрос позволяет создать компонент.

POST

https://api.tracker.yandex.net/v3/components

Формат запроса

Перед выполнением запроса получите доступ к API.

Чтобы создать компонент, используйте HTTP-запрос с методом POST:

POST /v3/components
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
  "name": "<имя_компонента>",
  "queue": "<ключ_очереди>"
}
Заголовки
  • 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.

    Чтобы узнать идентификатор организации, перейдите на страницу АдминистрированиеОрганизации и скопируйте значение поля идентификатор.

Параметры тела запроса

Обязательные параметры

Параметр Значение Тип данных
name Название компонента. Строка
queue Ключ очереди, в которой будет создан компонент. Строка

Дополнительные параметры

Параметр Описание Тип данных
description Описание компонента. Строка
lead Логин владельца компонента. Строка
assignAuto Признак исполнителя по умолчанию:
  • true — назначить владельца исполнителем по умолчанию;
  • false — не назначать исполнителя по умолчанию.
Логический

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 201 Created.

Тело ответа содержит JSON-объект с параметрами созданного компонента.

  {
     "self": "https://api.tracker.yandex.net/v3/components/111175",
     "id": 111175,
     "version": 1,
     "name": "Component",
     "queue": {
        "self": "https://api.tracker.yandex.net/v3/queues/TEST",
        "id": "12345",
        "key": "TEST",
        "display": "My queue"
     },
     "assignAuto": false
  }
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит параметры компонента. Строка
id Идентификатор компонента. Число
version Версия компонента. Каждое изменение параметров компонента увеличивает номер версии. Число
name Название компонента. Строка
queue Объект с информацией об очереди, в которую добавлен компонент. Объект
assignAuto Признак назначения владельца исполнителем по умолчанию. Логический

Поля объекта queue

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию об очереди. Строка
id Идентификатор очереди. Строка
key Ключ очереди. Строка
display Отображаемое название очереди. Строка

Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

400
Один или несколько параметров запроса имеют недопустимое значение.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
409
При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.
500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503
Сервис API временно недоступен.