Связаться с намиПодключиться

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

Статья создана
Обновлена 26 августа 2024 г.

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

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

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

Чтобы создать очередь, используйте HTTP-запрос с методом POST. Параметры запроса передаются в его теле в формате JSON.

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

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

  • Host

    Адрес узла, предоставляющего API:

    api.tracker.yandex.net

  • Authorization

    OAuth-токен в формате OAuth <OAuth-токен>, например:

    OAuth 0c4181a7c2cf4521964a72ff********

  • X-Org-ID или X-Cloud-Org-ID

    Идентификатор организации. Узнать его можно на странице организаций Tracker.

    • Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок X-Org-ID.
    • Если к Tracker привязана только организация Yandex Cloud Organization, используется заголовок X-Cloud-Org-ID.
    • Если к Tracker одновременно привязаны организации Яндекс 360 для бизнеса и Yandex Cloud Organization, используется заголовок X-Org-ID и идентификатор организации Яндекс 360 для бизнеса.
Параметры тела запроса

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

Параметр Описание Тип данных
key Ключ очереди Строка
name Название очереди Строка
lead Логин или идентификатор владельца очереди Строка
defaultType Идентификатор или ключ типа задач по умолчанию Строка
defaultPriority Идентификатор или ключ приоритета задач по умолчанию Строка
issueTypesConfig Массив с настройками типов задач очереди Массив объектов

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

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

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

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

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

{
       "self": "https://api.tracker.yandex.net/v2/queues/DESIGN",
       "id": "111",
       "key": "DESIGN",
       "version": 1400150916068,
       "name": "Дизайн",
       "lead": {
          "self": "https://api.tracker.yandex.net/v2/users/44********",
          "id": "artemredkin",
          "display": "Artem Redkin"
    },
       "assignAuto": false,
       "allowExternals" : false,
       "defaultType": {
          "self": "https://api.tracker.yandex.net/v2/issuetypes/2",
          "id": "2",
          "key": "task",
          "display": "Task"
   },
       "defaultPriority": {
          "self": "https://api.tracker.yandex.net/v2/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. Число

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

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

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

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

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

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