FlowmageDocs

Add comment

BetaChanges data

Adds a comment to a Jira issue.

Settings

SettingWhat it is
ConnectionRequiredThe Jira connection the step signs in with.
Issue keyRequiredtext
Comment format"text" or "adf"
CommentA blank line starts a new paragraph and a single newline becomes a line break; nothing else is interpreted.
Comment (ADF)A full Atlassian Document Format document: { "type": "doc", "version": 1, "content": [ … ] }.
Visible toA role or a group restricts it — the name must match a Jira project role or group exactly.
Role or group nametext
The customer may see itOn a Jira Service Management project, off makes this an internal note the customer does not see. It is ignored on a plain Jira project.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `jira`)
issuetext
bodyFormat"text" or "adf", by default "text"
bodytextused when `bodyFormat` is "text"
bodyAdfobject (any keys), by default {}used when `bodyFormat` is "adf"
visibilityType"" or "role" or "group"
visibilityValuetextused when `visibilityType` is not ""
jsdPublictrue/false, by default true

Output

FieldType
commentIdstring
commentobject
issueRefIssue keystring
Sample output, and the expression for each field
  • comment{}
  • commentId"10100"
  • issueRef"ENG-142"

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": {
    "body": "",
    "bodyAdf": {},
    "bodyFormat": "text",
    "connection": "<connection id>",
    "issue": "<issue key>",
    "jsdPublic": true,
    "visibilityType": "",
    "visibilityValue": ""
  },
  "label": "Add comment",
  "type": "jira.addComment",
  "version": 1
}