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.

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.

Examples

• With default site from global variables.

  node {
    stage('JIRA') {
      def attachment = jiraDownloadAttachment id: '1000', file: 'test.txt', override: false
      echo attachment.data.toString()
    }
  }
  

• withEnv to override the default site (or if there is not global site)

  node {
    stage('JIRA') {
      withEnv(['JIRA_SITE=LOCAL']) {
      def attachment = jiraDownloadAttachment id: '1000', file: 'test.txt', override: true
      echo attachment.data.toString()
      }
    }
  }
  

• Without environment variables.

  def attachment = jiraDownloadAttachment id: '1000', file: 'test.txt', override: true, site: 'LOCAL'
  echo attachment.data.toString()