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

Получить параметры автодействия

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

Запрос позволяет получить информацию об автодействии.

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

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

Чтобы получить параметры автодействия, используйте HTTP-запрос с методом GET.

GET /v2/queues/<ключ_или_идентификатор_очереди>/autoactions/<идентификатор_автодействия>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки

  • 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 для бизнеса.
Ресурс
Параметр Описание Тип данных
<ключ_или_идентификатор_очереди> Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов. Строка или число
<идентификатор_автодействия> Идентификатор автодействия. Число

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

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

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

{
  "id": 9,
  "self": "https://api.tracker.yandex.net/v2/queues/DESIGN/autoactions/9",
  "queue": {
      "self": "https://api.tracker.yandex.net/v2/queues/DESIGN",
      "id": "26",
      "key": "DESIGN",
      "display": "Дизайн"
  },
  "name": "autoaction_name",
  "version": 4,
  "active": true,
  "created": "2021-04-15T04:49:44.802+0000",
  "updated": "2022-01-26T16:29:05.356+0000", 
  "filter": {
      "priority": [
          "critical"
      ]
  },
  "actions": [
      {
          "type": "Transition",
          "id": 1,
          "status": {
              "self": "https://api.tracker.yandex.net/v2/statuses/2",
              "id": "2",
              "key": "needInfo",
              "display": "Требуется информация"
          }
      }
  ],
  "enableNotifications": false,
  "lastLaunch": "2022-02-01T14:09:48.216+0000",
  "totalIssuesProcessed": 0,
  "intervalMillis": 3600000,
  "calendar": {
          "id": 2
      }    
}
Параметры ответа
Параметр Описание Тип данных
id Идентификатор автодействия. Строка
self Ссылка на автодействие. Строка
queue Очередь, в которой создано автодействие. Может задаваться как объект, как строка (если передается ключ очереди), как число (если передается идентификатор очереди).
name Название автодействия. Строка
version Версия автодействия. Каждое изменение автодействия увеличивает номер версии. Число
active Статус автодействия. Допустимые значения:
  • true— активный;
  • false— неактивный.
 Логический
created Дата и время создания автодействия в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Строка
updated Дата и время последнего изменения автодействия в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Строка
filter Массив с условиями фильтрации полей задач, для которых сработает автодействие. Массив объектов
query Строка запроса для фильтрации задач. Строка
actions Массив с действиями над задачами. Массив объектов
enableNotifications Статус отправки уведомления. Допустимые значения:
  • true— отправлять;
  • false— не отправлять.
 Логический
lastLaunch Дата и время последнего срабатывания автодействия в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Строка
totalIssuesProcessed Количество задач, которые были проверены автодействием при последнем срабатывании. Число
intervalMillis Периодичность запуска автодействия в миллисекундах. По умолчанию выставляется значение 3600000 (1 раз в час). Число
calendar Период, в который автодействие активно. Имеет параметр id — идентификатор графика работы. Объект

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

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

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

Параметр Описание Тип данных
filter Массив с условиями фильтрации полей задач.
Используйте запрос, чтобы получить идентфиикатор глобального или локального поля.		 Массив объектов

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

Параметр Описание Тип данных
type Тип действия. Допустимые значения:
  • Transition— изменить статус задачи;
  • Update— изменить значения в полях;
  • Event.comment-create— добавить комментарий;
  • Webhook— отправить HTTP-запрос;
  • CalculateFormula— вычислить значение;
 Строка
id Идентификатор действия. Строка
status Статус задачи. Строка

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

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

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

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