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 : String
  • comment : String
  • auditLog : boolean (optional)
  • failOnError : boolean (optional)
  • input : Object (optional)
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site : String (optional)

jiraAddWatcher: JIRA Steps: Add Watcher

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

jiraAssignIssue: JIRA Steps: Assign Issue

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

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

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

jiraDeleteAttachment: JIRA Steps: Delete Attachment

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

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

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

jiraEditComment: JIRA Steps: Edit Issue Comment

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

jiraEditComponent: JIRA Steps: Edit Component

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

jiraEditIssue: JIRA Steps: Edit Issue

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

jiraEditVersion: JIRA Steps: Edit Version

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

jiraGetAttachmentInfo: JIRA Steps: Get Attachment Info

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

jiraGetComment: JIRA Steps: Get Issue Comment

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

jiraGetComments: JIRA Steps: Get Issue Comments

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

jiraGetComponent: JIRA Steps: Get Component

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

jiraGetComponentIssueCount: JIRA Steps: Get Component Issue Count

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

jiraGetFields: JIRA Steps: Get Fields

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

jiraGetIssue: JIRA Steps: Get Issue

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

jiraGetIssueTransitions: JIRA Steps: Get Issue Transitions

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

jiraGetIssueWatches: JIRA Steps: Get Issue Watches

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

jiraGetProject: JIRA Steps: Get Project

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

jiraGetProjectComponents: JIRA Steps: Get Project Components

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

jiraGetProjectStatuses: JIRA Steps: Get Project Statuses

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

jiraGetProjectVersions: JIRA Steps: Get Project Versions

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

jiraGetProjects: JIRA Steps: Get Projects

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

jiraGetServerInfo: JIRA Steps: Get Server Info

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

jiraGetVersion: JIRA Steps: Get Version

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

jiraNewComponent: JIRA Steps: Create New Component

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

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 : boolean (optional)
  • failOnError : boolean (optional)
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site : String (optional)
  • idOrKey : String
  • remoteLink : Object
  • auditLog : boolean (optional)
  • failOnError : boolean (optional)
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site : String (optional)

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 : boolean (optional)
  • failOnError : boolean (optional)
  • queryParams (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • site : String (optional)

jiraNewVersion: JIRA Steps: Create New Version

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

jiraNotifyIssue: JIRA Steps: Notify Issue

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

jiraTransitionIssue: JIRA Steps: Transition Issue

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

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

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

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

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

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.