Создать очередь

Запрос позволяет создать очередь.

POST

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

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

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

Чтобы создать очередь, используйте HTTP-запрос с методом POST. В теле запроса укажите параметры в формате JSON.

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

{
    "key": "DESIGN",
    "name": "Design",
    "lead": "username",
    "defaultType": "task",
    "defaultPriority": "normal",
    "issueTypesConfig":[
                {"issueType":"task", 
                  "workflow":"oicn", 
                  "resolutions":["wontFix",...]},
  ...
  ]
}
Заголовки

  • 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 Название очереди Строка
lead Логин или идентификатор владельца очереди Строка
defaultType Идентификатор или ключ типа задач по умолчанию Строка
defaultPriority Идентификатор или ключ приоритета задач по умолчанию Строка
issueTypesConfig Массив с настройками типов задач очереди Массив объектов

Поля объектов массива issueTypesConfig

Параметр Описание Тип данных
issueType Ключ типа задачи Строка
workflow Идентификатор рабочего процесса Строка
resolutions Массив с идентификаторами или ключами возможных резолюций Массив

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

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

Тело запроса содержит информацию о созданной очереди в формате JSON.

{
       "self": "https://api.tracker.yandex.net/v3/queues/DESIGN",
       "id": "111",
       "key": "DESIGN",
       "version": 1400150916068,
       "name": "Design",
       "lead": {
          "self": "https://api.tracker.yandex.net/v3/users/11********",
          "id": "11********",
          "display": "Имя Фамилия",
          "cloudUid": "ajeppa7dgp53********",
          "passportUid": 11********
    },
       "assignAuto": false,
       "allowExternals" : false,
       "defaultType": {
          "self": "https://api.tracker.yandex.net/v3/issuetypes/2",
          "id": "2",
          "key": "task",
          "display": "Task"
   },
       "defaultPriority": {
          "self": "https://api.tracker.yandex.net/v3/priorities/2",
          "id": "2",
          "key": "normal",
          "display": "Normal"
  }
}
Параметры ответа
Параметр Описание Тип данных
self Ссылка на очередь. Строка
id Идентификатор очереди. Число в формате строки
key Ключ очереди. Строка
version Версия очереди. Каждое изменение очереди увеличивает номер версии. Число
name Название очереди. Строка
lead Блок с информацией о владельце очереди. Объект
assignAuto Автоматически назначить исполнителя для новых задач очереди:
  • true— назначить;
  • false— не назначать.
 Логический
allowExternals Разрешить отправку писем наружу. Допустимые значения:
  • true— разрешить;
  • false— не разрешать.
 Логический
defaultType Блок с информацией о типе задачи по умолчанию. Объект
defaultPriority Блок с информацией о приоритете задачи по умолчанию. Объект
Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Строка
display Отображаемое имя пользователя. Строка
passportUid Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. Число
cloudUid Уникальный идентификатор пользователя в Yandex Cloud Organization. Строка

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

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

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

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

Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:

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