Settings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Jira connection the step signs in with. |
| Issue keyRequired | text |
| Summary | text |
| Description format | "none" or "text" or "adf" |
| Description | A blank line starts a new paragraph and a single newline becomes a line break; nothing else is interpreted. |
| Description (ADF) | A full Atlassian Document Format document: { "type": "doc", "version": 1, "content": [ … ] }. |
| Assignee account id | The Find users node gives you an account id. |
| Priority | text |
| Labels | Comma-separated, and Jira REPLACES the whole list with what you send. A label may not contain a space. |
| Due date | text |
| Parent issue key | text |
| Components | Comma-separated names. |
| Fix versions | Comma-separated names. |
| Custom fields | Keyed by id — customfield_10034. The List fields node gives you the ids. |
| Extra fields (raw JSON) | Merged into the fields object verbatim, for a field whose value is an object or an array — { "customfield_10050": { "value": "Red" } }. |
| Comment with this change | Added in the same update, so the change and its reason are one event. |
| Notify watchers | On, a second run sends a second notification even when nothing actually changed. |
| Read the issue back | Jira answers nothing at all unless you ask for the issue. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `jira`) |
issue | text |
summary | text |
descriptionFormat | "none" or "text" or "adf", by default "none" |
description | textused when `descriptionFormat` is "text" |
descriptionAdf | object (any keys), by default {}used when `descriptionFormat` is "adf" |
assigneeAccountId | text |
priority | text |
labels | text |
dueDate | text |
parent | text |
components | text |
fixVersions | text |
customFields | object of text, by default {} |
extraFields | object (any keys), by default {} |
historyComment | text |
notifyUsers | true/false, by default true |
returnIssue | true/false, by default false |
Output
| Field | Type |
|---|---|
issueRefIssue key | string |
updatedJira accepted the change | boolean |
issueIssue (only when read back) | object |
Sample output, and the expression for each field
- issue{}
- issueRef"ENG-142"
- updatedtrue
Errors
When a step of this node stops a run, the run page shows a code. Look it up:
Example step
The step as a flow file holds it. Replace each value in <…>.
{
"config": {
"assigneeAccountId": "",
"components": "",
"connection": "<connection id>",
"customFields": {},
"description": "",
"descriptionAdf": {},
"descriptionFormat": "none",
"dueDate": "",
"extraFields": {},
"fixVersions": "",
"historyComment": "",
"issue": "<issue key>",
"labels": "",
"notifyUsers": true,
"parent": "",
"priority": "",
"returnIssue": false,
"summary": ""
},
"label": "Update issue",
"type": "jira.updateIssue",
"version": 1
}