steps

jiraDownloadAttachment This step downloads the attachment of an issue to given location in workspace. Input id - Attachment Id. file - Target location including file name. Ex: test.txt or test/test.txt override - Overrides an existing file. Defaults to false. site - Optional, default: JIRA_SITE environment variable. failOnError - Optional. default: true. Output Each step generates generic output, please refer to this link for more information. The api response of this step can be reused later in your script by doing response. »

jiraAddComment This step adds a comment on a particular issue. Input idOrKey - Issue id or key. input - comment, supports jira wiki formatting. site - Optional, default: JIRA_SITE environment variable. failOnError - Optional. default: true. auditLog - Optional. default: true. Append a panel to the comment with the build url and build user name. Deprecated: comment - comment, supports jira wiki formatting. Output Each step generates generic output, please refer to this link for more information. »

jiraEditComponent Edit component based on given input, which should have some minimal information on that object. Input id - component id. (Note: Applicable only from version 1.3.0) component - component to be edited. site - Optional, default: JIRA_SITE environment variable. failOnError - Optional. default: true. auditLog - Optional. default: true. Append the build url and build user name to the description. Output Each step generates generic output, please refer to this link for more information. »

jiraEditVersion Edit version based on given input, which should have some minimal information on that object. Note: Sometimes it may not possible to directly edit version (rename it) without un tagging all of its current JIRAs. TODO: probably we should try move version Input id - version id. (Note: Applicable only from version 1.3.0) version - version to be edited. site - Optional, default: JIRA_SITE environment variable. failOnError - Optional. »

jiraGetProjectComponents This step queries all components of a particular project. Input idOrKey - project id or key. site - Optional, default: JIRA_SITE environment variable. failOnError - Optional. default: true. Output Each step generates generic output, please refer to this link for more information. The api response of this jira_get_project_components step can be reused later in your script by doing response.data.required_field_name. You can see some example scenarios here All the available fields for a jira response can be found in JIRA API documentation depending on your JIRA version. »

jiraGetRemoteIssueLink This step queries a particular remote link of an issue. Input idOrKey - issue id or key. linkId - remote link id. site - Optional, default: JIRA_SITE environment variable. failOnError - Optional. default: true. Output Each step generates generic output, please refer to this link for more information. The api response of this jira_get_remote_issue_link step can be reused later in your script by doing response.data.required_field_name. You can see some example scenarios here All the available fields for a jira response can be found in JIRA API documentation depending on your JIRA version. »

jiraNewIssues This step creates new issues in bulk in the provided JIRA site. Input issues - issues to be created. site - Optional, default: JIRA_SITE environment variable. failOnError - Optional. default: true. auditLog - Optional. default: true. Append a panel to the comment with the build url and build user name. Output Each step generates generic output, please refer to this link for more information. The api response of this jira_new_issues step can be reused later in your script by doing response. »

jiraDeleteAttachment This step deletes the attachment from an issue. Input id - Attachment Id. site - Optional, default: JIRA_SITE environment variable. failOnError - Optional. default: true. Output Each step generates generic output, please refer to this link for more information. The api response of this step can be reused later in your script by doing response.data.required_field_name. You can see some example scenarios here All the available fields for a JIRA response can be found in JIRA API documentation depending on your JIRA version. »

jiraAssignIssue This step assigns a particular issue to a user. Input idOrKey - Issue id or key. userName - username of the person who should be added as a watcher. accountId - accountId of the person who should be added as a watcher. Only applicable for GDPR instances. site - Optional, default: JIRA_SITE environment variable. failOnError - Optional. default: true. Output Each step generates generic output, please refer to this link for more information. »

jiraEditComment This step updates a particular comment on particular issue. Input idOrKey - Issue id or key. commentId - comment id. input - comment, supports jira wiki formatting. site - Optional, default: JIRA_SITE environment variable. failOnError - Optional. default: true. Deprecated: comment - comment, supports jira wiki formatting. Output Each step generates generic output, please refer to this link for more information. The api response of this jira_edit_comment step can be reused later in your script by doing response. »