Skip to content

Jira

Node: jira · Full type: n8n-nodes-base.jira · Version: 1

Credentials

jiraSoftwareCloudApi (alias: @jira) / jiraSoftwareServerApi (alias: @jira) / jiraSoftwareServerPatApi (alias: @jira)

CREDENTIAL @jira = jiraSoftwareCloudApi "My Jira"

Operations

Resource: issue

changelog

Parameter Type Default Details
issueKey string "" required
returnAll boolean false
limit number 50

create

Parameter Type Default Details
project resourceLocator {...} required; modes: list, id
issueType resourceLocator {...} required; modes: list, id
summary string "" required
additionalFields collection {} keys: assignee, description, componentIds, customFieldsUi, labels, serverLabels, ...

delete

Parameter Type Default Details
issueKey string "" required
deleteSubtasks boolean false required

get

Parameter Type Default Details
issueKey string "" required
simplifyOutput boolean false
additionalFields collection {} keys: expand, fields, fieldsByKey, properties, updateHistory

getAll

Parameter Type Default Details
returnAll boolean false
limit number 50
options collection {} keys: expand, fields, fieldsByKey, jql

notify

Parameter Type Default Details
issueKey string "" required
jsonParameters boolean false
additionalFields collection {} keys: htmlBody, subject, textBody
notificationRecipientsUi fixedCollection {} groups: notificationRecipientsValues
notificationRecipientsJson json ""
notificationRecipientsRestrictionsUi fixedCollection {} groups: notificationRecipientsRestrictionsValues
notificationRecipientsRestrictionsJson json ""

transitions

Parameter Type Default Details
issueKey string "" required
additionalFields collection {} keys: expand, transitionId, skipRemoteOnlyCondition

update

Parameter Type Default Details
issueKey string "" required
updateFields collection {} keys: assignee, description, customFieldsUi, issueType, labels, serverLabels, ...

Resource: issueAttachment

add

Parameter Type Default Details
issueKey string "" required
binaryPropertyName string "data" required

get

Parameter Type Default Details
attachmentId string "" required
download boolean false required
binaryProperty string "data" required

getAll

Parameter Type Default Details
issueKey string "" required
returnAll boolean false
limit number 50
download boolean false required
binaryProperty string "data" required

remove

Parameter Type Default Details
attachmentId string "" required

Resource: issueComment

add

Parameter Type Default Details
issueKey string "" required
jsonParameters boolean false
comment string ""
commentJson json ""
options collection {} keys: expand, wikiMarkup

get

Parameter Type Default Details
issueKey string "" required
commentId string "" required
options collection {} keys: expand

getAll

Parameter Type Default Details
issueKey string "" required
returnAll boolean false
limit number 50
options collection {} keys: expand, orderBy

remove

Parameter Type Default Details
issueKey string "" required
commentId string "" required

update

Parameter Type Default Details
issueKey string "" required
commentId string "" required
jsonParameters boolean false
comment string ""
commentJson json ""
options collection {} keys: expand, wikiMarkup

Resource: user

create

Parameter Type Default Details
username string "" required
emailAddress string "" required
displayName string "" required
additionalFields collection {} keys: password, notification

delete

Parameter Type Default Details
accountId string ""

get

Parameter Type Default Details
accountId string ""
additionalFields collection {} keys: expand

Common Parameters

Parameter Type Default Details
jiraVersion options "cloud" cloud, server, serverPat

Parameter Details

additionalFields children:

Parameter Type Default Details
assignee resourceLocator {...} modes: list, id
description string ""
componentIds multiOptions []
customFieldsUi fixedCollection {} groups: customFieldsValues
labels multiOptions []
serverLabels string []
parentIssueKey string ""
priority resourceLocator {...} modes: list, id
reporter resourceLocator {...} modes: list, id
updateHistory boolean false

updateFields children:

Parameter Type Default Details
assignee resourceLocator {...} modes: list, id
description string ""
customFieldsUi fixedCollection {} groups: customFieldsValues
issueType string ""
labels multiOptions []
serverLabels string []
parentIssueKey string ""
priority resourceLocator {...} modes: list, id
reporter resourceLocator {...} modes: list, id
summary string ""
statusId resourceLocator {...} modes: list, id

options children:

Parameter Type Default Details
expand multiOptions [] multi: changelog, editmeta, names, operations, renderedFields, schema, transitions, versionedRepresentations
fields string "*navigable"
fieldsByKey boolean false
jql string ""

notificationRecipientsUi children:

notificationRecipientsValues group:

Parameter Type Default Details
reporter boolean false
assignee boolean false
watchers boolean false
voters boolean false
users multiOptions []
groups multiOptions []

notificationRecipientsRestrictionsUi children:

notificationRecipientsRestrictionsValues group:

Parameter Type Default Details
users multiOptions []
groups multiOptions []

Example

NODE "jira" @jira AS "Jira" {
  resource: "issue",
  operation: "get",
  summary: {{ $json.summary }},
  issueKey: {{ $json.issueKey }},
  binaryPropertyName: {{ $json.binaryPropertyName }}
}