Jira

Jira node reference - all 80 operations, the credential it needs, and a worked example.

Jira Cloud. Issues (create, read, update, delete, assign, transition, bulk create), comments, attachments, worklogs, watchers and votes, issue and remote links, projects, components and versions, metadata lookups, users and permissions, plus Jira Software boards, sprints, epics, backlog and ranking.

Credential: Jira credential - see Credentials.

Scopes

Each operation below lists the scope it needs. Scopes are the granular scope an OAuth 2.0 (3LO) app would request. Pipory's Jira credential is an API TOKEN, which carries the calling user's own permissions rather than a scope subset - so a refusal means that user lacks the PROJECT permission, not that a scope is unticked. If a run fails with a permission error, the node names the missing scope in the error - grant it and re-run; you do not need to rebuild the workflow.

Operations (80)

Issues — read

Operation	What it does	Scope
`getIssue`	Get issue	`read:jira-work`
`searchIssues`	Search issues (JQL)	`read:jira-work`
`approximateCount`	Count issues matching JQL	`read:jira-work`
`bulkFetchIssues`	Get many issues by key	`read:jira-work`
`pickIssues`	Suggest issues (autocomplete)	`read:jira-work`
`matchIssues`	Check issues against JQL	`read:jira-work`
`getChangelog`	Get issue change history	`read:jira-work`
`getEditMeta`	Get editable fields for an issue	`read:jira-work`

Issues — write

Operation	What it does	Scope
`createIssue`	Create issue	`write:jira-work`
`updateIssue`	Update issue	`write:jira-work`
`deleteIssue`	Delete issue	`write:jira-work`
`assignIssue`	Assign issue	`write:jira-work`
`bulkCreateIssues`	Create many issues	`write:jira-work`
`sendNotification`	Email a notification about an issue	`write:jira-work`

Issues — workflow transitions

Operation	What it does	Scope
`getTransitions`	List available transitions	`read:jira-work`
`transitionIssue`	Transition issue	`write:jira-work`

Comments

Operation	What it does	Scope
`getComments`	List comments on an issue	`read:jira-work`
`getComment`	Get comment	`read:jira-work`
`addComment`	Add comment	`write:jira-work`
`updateComment`	Update comment	`write:jira-work`
`deleteComment`	Delete comment	`write:jira-work`

Attachments

Operation	What it does	Scope
`getAttachments`	List an issue's attachments	`read:jira-work`
`addAttachment`	Upload an attachment	`write:jira-work`
`getAttachmentMetadata`	Get attachment metadata	`read:jira-work`
`downloadAttachment`	Download attachment contents	`read:jira-work`
`deleteAttachment`	Delete attachment	`write:jira-work`
`getAttachmentSettings`	Get attachment settings	`read:jira-work`

Worklogs

Operation	What it does	Scope
`getWorklogs`	List worklogs on an issue	`read:jira-work`
`addWorklog`	Log time on an issue	`write:jira-work`
`updateWorklog`	Update worklog	`write:jira-work`
`deleteWorklog`	Delete worklog	`write:jira-work`

Watchers and votes

Operation	What it does	Scope
`getWatchers`	List watchers	`read:jira-work`
`addWatcher`	Add watcher	`write:jira-work`
`removeWatcher`	Remove watcher	`write:jira-work`
`getVotes`	Get votes	`read:jira-work`
`addVote`	Vote for an issue	`write:jira-work`
`removeVote`	Remove your vote	`write:jira-work`

Issue links

Operation	What it does	Scope
`getIssueLinkTypes`	List issue link types	`read:jira-work`
`createIssueLink`	Link two issues	`write:jira-work`
`getIssueLink`	Get issue link	`read:jira-work`
`deleteIssueLink`	Delete issue link	`write:jira-work`
`getRemoteLinks`	List remote links	`read:jira-work`
`createRemoteLink`	Create or update a remote link	`write:jira-work`
`deleteRemoteLink`	Delete remote link	`write:jira-work`

Projects, components and versions

Operation	What it does	Scope
`searchProjects`	Search projects	`read:jira-work`
`getProject`	Get project	`read:jira-work`
`getProjectStatuses`	Get statuses for a project	`read:jira-work`
`getProjectComponents`	List project components	`read:jira-work`
`getProjectVersions`	List project versions	`read:jira-work`
`createVersion`	Create version	`write:jira-work`
`updateVersion`	Update or release a version	`manage:jira-project`

Metadata

Operation	What it does	Scope
`getCreateMetaIssueTypes`	List creatable issue types for a project	`read:jira-work`
`getCreateMetaFields`	List fields for a project and issue type	`read:jira-work`
`getIssueTypes`	List issue types	`read:jira-work`
`getFields`	List fields (map names to custom field ids)	`read:jira-work`
`getPriorities`	List priorities	`read:jira-work`
`getStatuses`	List statuses	`read:jira-work`
`getResolutions`	List resolutions	`read:jira-work`
`getLabels`	List labels	`read:jira-work`

Users and permissions

Operation	What it does	Scope
`getCurrentUser`	Get the authenticated user	`read:jira-user`
`getUser`	Get user by account ID	`read:jira-user`
`searchUsers`	Search users	`read:jira-user`
`findAssignableUsers`	Find users assignable to an issue or project	`read:jira-user`
`getMyPermissions`	Get my permissions	`read:jira-user`

Agile — boards and backlog

Operation	What it does	Scope
`getBoards`	List boards	`read:board-scope:jira-software`
`getBoard`	Get board	`read:board-scope:jira-software`
`getBoardIssues`	List issues on a board	`read:board-scope:jira-software`
`getBacklogIssues`	List backlog issues	`read:board-scope:jira-software`
`moveIssuesToBacklog`	Move issues to the backlog	`write:board-scope:jira-software`
`rankIssues`	Rank issues	`write:issue:jira-software`

Agile — sprints and epics

Operation	What it does	Scope
`getBoardSprints`	List sprints on a board	`read:sprint:jira-software`
`getSprint`	Get sprint	`read:sprint:jira-software`
`createSprint`	Create sprint	`write:sprint:jira-software`
`updateSprint`	Update, start or complete a sprint	`write:sprint:jira-software`
`deleteSprint`	Delete sprint	`write:sprint:jira-software`
`getSprintIssues`	List issues in a sprint	`read:sprint:jira-software`
`moveIssuesToSprint`	Move issues into a sprint	`write:sprint:jira-software`
`getEpicIssues`	List issues in an epic	`read:epic:jira-software`
`moveIssuesToEpic`	Move issues into an epic	`write:epic:jira-software`
`removeIssuesFromEpic`	Remove issues from their epic	`write:epic:jira-software`

Example

Move an issue to Done — which is a transition, not a field write

Setting an issue's status by updating a status field does not work in Jira: status is owned by the workflow, and the only legal way to change it is to execute a transition that the issue's current status actually offers. Which transitions exist depends on where the issue is right now, so a workflow that hardcodes a transition id breaks the first time an admin edits the workflow. Naming the transition instead survives that.

Set Operation to transitionIssue, then fill in:

Field	Value	Notes
`issueKey`	`{{ myTrigger.issueKey }}`	e.g. ENG-1423
`transitionName`	`Done`	Matched against the transitions available FROM the issue's current status. Use getTransitions first if you want to branch on what is legal
`commentBody`	`Closed automatically by Pipory after the deploy succeeded.`	Optional; posted as part of the same transition so the audit trail shows why it moved

Sets {{done.issueKey}} and {{done.transition}}. A transition the issue does not currently offer fails the node with the list of ones it does, rather than silently doing nothing.

On this page