FlowmageDocs

Update issue

BetaChanges data

Changes fields on a Jira issue.

Settings

SettingWhat it is
ConnectionRequiredThe Jira connection the step signs in with.
Issue keyRequiredtext
Summarytext
Description format"none" or "text" or "adf"
DescriptionA 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 idThe Find users node gives you an account id.
Prioritytext
LabelsComma-separated, and Jira REPLACES the whole list with what you send. A label may not contain a space.
Due datetext
Parent issue keytext
ComponentsComma-separated names.
Fix versionsComma-separated names.
Custom fieldsKeyed 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 changeAdded in the same update, so the change and its reason are one event.
Notify watchersOn, a second run sends a second notification even when nothing actually changed.
Read the issue backJira answers nothing at all unless you ask for the issue.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `jira`)
issuetext
summarytext
descriptionFormat"none" or "text" or "adf", by default "none"
descriptiontextused when `descriptionFormat` is "text"
descriptionAdfobject (any keys), by default {}used when `descriptionFormat` is "adf"
assigneeAccountIdtext
prioritytext
labelstext
dueDatetext
parenttext
componentstext
fixVersionstext
customFieldsobject of text, by default {}
extraFieldsobject (any keys), by default {}
historyCommenttext
notifyUserstrue/false, by default true
returnIssuetrue/false, by default false

Output

FieldType
issueRefIssue keystring
updatedJira accepted the changeboolean
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
}