Действия для коннектора Jira

Материал из Документация Ключ-АСТРОМ

Действия для коннектора Jira

Для коннектора Jira доступны следующие действия Workflow.

Изменить исполнителя

Изменить исполнителя задачи Jira.

Входные данные

Поле Описание Обязательно
Соединение Предварительно настроенное соединение с экземпляром Jira. Да
Ключ задачи Точный ключ задачи, например XYZ-1234. Также можно использовать выражения Workflow в качестве входных данных. Да
Исполнитель Имя пользователя-исполнителя. Да

Комментарий к задаче

Добавить комментарий к задаче Jira.

Входные данные

Поле Описание Обязательно
Соединение Предварительно настроенное соединение с экземпляром Jira. Да
Ключ задачи Точный ключ задачи, например XYZ-1234. Также можно использовать выражения Workflow в качестве входных данных. Да
Введите комментарий Комментарий. Отформатируйте сообщение с помощью нотации форматирования текста Jira. Также можно использовать выражения Workflow в качестве входных данных. Да

Результат

Действие «Комментарий к задаче» предоставляет следующий результат:

Свойство Описание
id Числовой ID комментария, например 123456.

Создать задачу

Создать новую задачу Jira с различными полями.

Входные данные

Поле Описание Обязательно
Соединение Предварительно настроенное соединение с экземпляром Jira. Да
Проект Имя проекта Jira. Да
Тип задачи Тип задачи. Да
Приоритет Установленный приоритет. Нет
Исполнитель Имя исполнителя. Нет
Автор Имя автора. Нет
Метки Метки Jira. Нет
Компоненты Компоненты Jira. Нет
Сводка Текст сводки. Будет усечён до 255 символов. Да
Описание Описание задачи Jira. Нет
Поля Поля Jira. Нет

Синтаксис значений настраиваемых полей зависит от типа настраиваемого поля. Подробнее см. документацию Jira по настройке данных настраиваемых полей для других типов полей. Если у вас возникли трудности с поиском ID настраиваемых полей, можно использовать XML-представление задачи Jira, доступное по адресу https://.atlassian.net/si/jira.issueviews:issue-xml/XYZ-1234/XYZ-1234.xml.

Примеры:

Ключ Значение
FreeTextField "customfield_10004": "Free text goes here. Type away!"
GroupPicker "customfield_10005": { "name": "jira-developers" }
MultiSelect "customfield_10008": [ {"value": "red" }, {"value": "blue" }, {"value": "green" }]
NumberField "customfield_10010": 42.07

Результат

Действие «Создать задачу» предоставляет следующий результат:

Свойство Описание
id Числовой ID только что созданной задачи Jira, например 1234567.
key Ключ Jira только что созданной задачи Jira, например XYZ-1234.
url URL, ведущий к только что созданной задаче Jira, например https://.atlassian.net/browse/XYZ-1234.

Редактировать задачу

Редактировать уже существующую задачу Jira.

Поле Описание Обязательно
Соединение Предварительно настроенное соединение с экземпляром Jira. Да
Ключ задачи Точный ключ задачи, например XYZ-1234. Также можно использовать выражения Workflow в качестве входных данных. Да
Введите комментарий Комментарий. Отформатируйте сообщение с помощью нотации форматирования текста Jira. Также можно использовать выражения Workflow в качестве входных данных. Нет
Поля Настраиваемое поле. Нет

Синтаксис значений настраиваемых полей зависит от типа настраиваемого поля. Подробнее см. документацию Jira по настройке данных настраиваемых полей для других типов полей. Если у вас возникли трудности с поиском ID настраиваемых полей, можно использовать XML-представление задачи Jira, доступное по адресу https://.atlassian.net/si/jira.issueviews:issue-xml/XYZ-1234/XYZ-1234.xml.

Примеры:

Ключ Значение
FreeTextField "customfield_10004": "Free text goes here. Type away!"
GroupPicker "customfield_10005": { "name": "jira-developers" }
MultiSelect "customfield_10008": [ {"value": "red" }, {"value": "blue" }, {"value": "green" }]
NumberField "customfield_10010": 42.07

Пример: передача массива через выражение Jinja

Если вам нужно передать массив в настраиваемое поле с помощью выражения Jinja, необходимо преобразовать массив в строку JSON с помощью функции to_json.

Например, предположим, что предшествующее действие JavaScript возвращает следующий объект:

return { labels: [ "some-label", "some-other-label" ]};

Чтобы присвоить этот массив настраиваемому полю labels, нужно сериализовать результат с помощью to_json, как показано ниже:

Ключ Значение
labels {{ result("run_javascript_1")["labels"] | to_json }}

Поскольку настраиваемое поле ожидает строку, функция to_json гарантирует, что массив будет правильно отформатирован как строка JSON.

Поиск JQL

Выполнять запросы JQL для получения задач из Jira.

Входные данные

Поле Описание Обязательно
Соединение Предварительно настроенное соединение с экземпляром Jira. Да
JQL Допустимый JQL для поиска, например PROJECT = CA AND assignee = null. Да
Поля Разделённый запятыми список полей, возвращаемых из поиска, например key,summary,created. Нет
Расширение Разделённый запятыми список сущностей, которые вы хотите расширить, например names, renderedFields. Нет
Максимальное количество результатов Максимальное количество результатов, возвращаемых поиском, например 10. Нет
  1. По умолчанию в этом ресурсе поиска возвращаются только навигируемые (*navigable) поля.
  2. Примеры фильтров: *all — включить все поля; *navigable — включить только навигируемые поля; summary,comment — включить только сводку и комментарии; -description — включить навигируемые поля, кроме описания (по умолчанию *navigable для поиска); *all,-comment — включить всё, кроме комментариев.
  3. Количество задач, возвращаемых одним запросом, будет усечено до 1000. Учтите, что действие может завершиться ошибкой, если результат слишком большой.

Результат

Вкладка Детали показывает состояние операции:

  • Успех, если операция поиска JQL прошла успешно.
  • Ошибка (с дополнительной информацией), если поиск не удался.

Вкладка Результат перечисляет все записи из поиска (если поиск был успешным).

Связать задачи

Связать две задачи Jira.

Входные данные

Поле Описание Обязательно
Соединение Предварительно настроенное соединение с экземпляром Jira. Да
Входящая задача Ключ связываемой задачи. Да
Тип связи Тип связи между двумя задачами. Да
Исходящая задача Ключ связываемой задачи. Да
Комментарий Комментарий к входящей связанной задаче. Нет

Перевести задачу

Перевести состояние задачи Jira.

Входные данные

Поле Описание Обязательно
Соединение Предварительно настроенное соединение с экземпляром Jira. Да
Ключ задачи Точный ключ задачи, например XYZ-1234. Да
Статус перехода Статус, который задача должна иметь после этого перехода. Здесь можно использовать выражения Workflow в качестве входных данных. Да
Введите комментарий Текст, который вы хотите добавить к задаче во время операции перехода. Также можно использовать выражения Workflow в качестве входных данных. Нет
Поля Настраиваемое поле. Нет

Синтаксис значений настраиваемых полей зависит от типа настраиваемого поля. Подробнее см. документацию Jira по настройке данных настраиваемых полей для других типов полей. Если у вас возникли трудности с поиском ID настраиваемых полей, можно использовать XML-представление задачи Jira, доступное по адресу https://.atlassian.net/si/jira.issueviews:issue-xml/XYZ-1234/XYZ-1234.xml.

Примеры:

Ключ Значение
FreeTextField "customfield_10004": "Free text goes here. Type away!"
GroupPicker "customfield_10005": { "name": "jira-developers" }
MultiSelect "customfield_10008": [ {"value": "red" }, {"value": "blue" }, {"value": "green" }]
NumberField "customfield_10010": 42.07

Результат

Действие «Перевести задачу» в настоящее время не предоставляет результатов, но вкладка Входные данные показывает все ID, связанные с переходом, а журналы предоставляют некоторую информацию.

Вкладка Детали показывает состояние операции:

  • Успех, если операция перехода прошла успешно.
  • Ошибка (с дополнительной информацией), если переход не удался.