> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Table of Contents

JIRA Pipeline Steps

View this plugin on the Plugins site

jiraAddComment: JIRA Steps: Add Comment

  • idOrKey
    • Type: String
  • comment
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • input (optional)
    • Type: Object
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraAddWatcher: JIRA Steps: Add Watcher

  • idOrKey
    • Type: String
  • userName
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraAssignIssue: JIRA Steps: Assign Issue

  • idOrKey
    • Type: String
  • userName
    • Type: String
  • accountId
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraAssignableUserSearch: JIRA Steps: Searches assignable JIRA Users by username, name or email address for the given project/issueKey

  • project
    • Type: String
  • issueKey
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • maxResults (optional)
    • Type: int
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • queryStr (optional)
    • Type: String
  • site (optional)
    • Type: String
  • startAt (optional)
    • Type: int

jiraDeleteAttachment: JIRA Steps: Delete Attachment

  • id
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String
  • id
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String
  • idOrKey
    • Type: String
  • linkId
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String
  • idOrKey
    • Type: String
  • globalId
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraDownloadAttachment: JIRA Steps: Download a file to workspace (directory is optional)

  • id
    • Type: String
  • file
    • Type: String
  • override
    • Type: boolean
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraEditComment: JIRA Steps: Edit Issue Comment

  • idOrKey
    • Type: String
  • commentId
    • Type: String
  • comment
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • input (optional)
    • Type: Object
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraEditComponent: JIRA Steps: Edit Component

  • id
    • Type: String
  • component
    • Type: Object
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraEditIssue: JIRA Steps: Edit Issue

  • idOrKey
    • Type: String
  • issue
    • Type: Object
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraEditVersion: JIRA Steps: Edit Version

  • id
    • Type: String
  • version
    • Type: Object
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraGetAttachmentInfo: JIRA Steps: Get Attachment Info

  • id
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraGetComment: JIRA Steps: Get Issue Comment

  • idOrKey
    • Type: String
  • commentId
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraGetComments: JIRA Steps: Get Issue Comments

  • idOrKey
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraGetComponent: JIRA Steps: Get Component

  • id
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraGetComponentIssueCount: JIRA Steps: Get Component Issue Count

  • id
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraGetFields: JIRA Steps: Get Fields

  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraGetIssue: JIRA Steps: Get Issue

  • idOrKey
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String
  • id
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String
  • idOrKey
    • Type: String
  • linkId
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String
  • idOrKey
    • Type: String
  • globalId
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraGetIssueTransitions: JIRA Steps: Get Issue Transitions

  • idOrKey
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraGetIssueWatches: JIRA Steps: Get Issue Watches

  • idOrKey
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraGetProject: JIRA Steps: Get Project

  • idOrKey
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraGetProjectComponents: JIRA Steps: Get Project Components

  • idOrKey
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraGetProjectStatuses: JIRA Steps: Get Project Statuses

  • idOrKey
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraGetProjectVersions: JIRA Steps: Get Project Versions

  • idOrKey
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraGetProjects: JIRA Steps: Get Projects

  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraGetServerInfo: JIRA Steps: Get Server Info

  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraGetVersion: JIRA Steps: Get Version

  • id
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String
  • jql
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • fields (optional)
    • Type: Object
  • maxResults (optional)
    • Type: int
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String
  • startAt (optional)
    • Type: int
  • type
    • Type: String
  • inwardKey
    • Type: String
  • outwardKey
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • comment (optional)
    • Type: String
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraNewComponent: JIRA Steps: Create New Component

  • component
    • Type: Object
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraNewIssue: JIRA Steps: Create New Issue

  • issue
      Nested Object
    • update
      • Type: java.util.Map<java.lang.String, java.lang.Object>
    • fields
      • Type: java.util.Map<java.lang.String, java.lang.Object>
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String
  • idOrKey
    • Type: String
  • remoteLink
    • Type: Object
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraNewIssues: JIRA Steps: Create New Issues

  • issues
      Nested Object
    • issueUpdates
        Array / List of Nested Object
      • update
        • Type: java.util.Map<java.lang.String, java.lang.Object>
      • fields
        • Type: java.util.Map<java.lang.String, java.lang.Object>
    • issues
        Array / List of Nested Object
      • update
        • Type: java.util.Map<java.lang.String, java.lang.Object>
      • fields
        • Type: java.util.Map<java.lang.String, java.lang.Object>
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraNewVersion: JIRA Steps: Create New Version

  • version
    • Type: Object
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraNotifyIssue: JIRA Steps: Notify Issue

  • idOrKey
    • Type: String
  • notify
    • Type: Object
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraTransitionIssue: JIRA Steps: Transition Issue

  • idOrKey
    • Type: String
  • input
    • Type: Object
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraUploadAttachment: JIRA Steps: Attach a file from workspace to an issue

  • idOrKey
    • Type: String
  • file
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String

jiraUserSearch: JIRA Steps: Search Active JIRA Users by username, name or email address.

  • queryStr
    • Type: String
  • auditLog (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • maxResults (optional)
    • Type: int
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site (optional)
    • Type: String
  • startAt (optional)
    • Type: int

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.