Steps

UploadAttachment

jiraUploadAttachment This step uploads a file from worksapce to issue. Input idOrKey - Issue Id or Key. file - File name with/without path from workspace. Ex: test.txt or test/test.txt. site - Optional, default: JIRA_SITE environment variable. failOnError - Optional. default: true. For more information about input, please refer to the model objects in the API package. Output Each step generates generic output, please refer to this link for more information. »

Server Info

jiraGetServerInfo This step retrives the server info. Input 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_jql_search 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. »

DownloadAttachment

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. For more information about input, please refer to the model objects in the API package. Output Each step generates generic output, please refer to this link for more information. »

AddComment

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. It supports all the fields that any jira instance supports including custom fields. »

DeleteRemoteIssueLink

jiraDeleteRemoteIssueLink This step deletes 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. It supports all the fields that any jira instance supports including custom fields. For more information about all available input fields, please refer to the JIRA API documentation depending on your JIRA version. »

DeleteRemoteIssueLinks

jiraDeleteRemoteIssueLinks This step deletes all remote links of an issue. Input idOrKey - issue id or key. globalId - global application id (Optional). site - Optional, default: JIRA_SITE environment variable. failOnError - Optional. default: true. It supports all the fields that any jira instance supports including custom fields. For more information about all available input fields, please refer to the JIRA API documentation depending on your JIRA version. »

EditComponent

jiraEditComponent Edit component based on given input, which should have some minimal information on that object. Sometimes it may not possible to directly edit component (rename it) without un tagging all of its current JIRAs. 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. »

EditVersion

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. »

GetComment

jiraGetComment This step queries a particular comment on an issue. Input idOrKey - Issue id or key. commentId - commentId. site - Optional, default: JIRA_SITE environment variable. failOnError - Optional. default: true. For more information about input, please refer to the model objects in the API package. Output Each step generates generic output, please refer to this link for more information. The api response of this jira_get_comment step can be reused later in your script by doing response. »

GetComponent

jiraGetComponent This step queries a particular component from the provided JIRA site. Input id - componentId. site - Optional, default: JIRA_SITE environment variable. failOnError - Optional. default: true. For more information about input, please refer to the model objects in the API package. Output Each step generates generic output, please refer to this link for more information. The api response of this jira_get_component step can be reused later in your script by doing response. »