steps

UserSearch

jiraUserSearch This step searches users by name, username or email address form the JIRA SITE. Input queryStr - name, username or email address. (partial string are allowed) 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_user_search step can be reused later in your script by doing response. »

GetAttachmentInfo

jiraGetAttachmentInfo This step queries a particular attachment’s info on 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. »

AddWatcher

jiraAddWatcher This step adds a user as watcher to a particular issue. Input idOrKey - Issue id or key. userName - username of the person who should be added as a watcher. 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_add_watcher step can be reused later in your script by doing response. »

AssignableUserSearch

jiraAssignableUserSearch This step searches for a user by name, username or email address and assigns them to given project and/or issueKey. Input queryStr - name, username or email address. (partial string are allowed) project - project key. Either project or issueKey is mandatory. issueKey - issue key. Either project or issueKey is mandatory. 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. »

GetComments

jiraGetComments This step queries all comments on a particular issue. Input idOrKey - Issue 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_comments 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. »

GetIssueLinkTypes

jiraGetIssueLinkTypes This step queries all issue links types from the provided JIRA site. 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_get_issue_link_types 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. »

GetProjects

jiraGetProjects This step queries all projects from the provided JIRA site. 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_get_projects 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. »

GetVersion

jiraGetVersion This step queries the project version from the provided JIRA site. Input id - version 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_version 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. »

NewComponent

jiraNewComponent Create new component based on given input, which should have some minimal information on that object. Input component - component to be created. 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. The api response of this jira_get_new_component step can be reused later in your script by doing response. »

NewIssue

jiraNewIssue Creates new issue based on given input, which should have some minimal information on that object. Input issue - issue 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. »