FlowmageDocs

List comments

BetaReads dataVersion 2

Reads the comments on a Jira issue.

Settings

SettingWhat it is
ConnectionRequiredThe Jira connection the step signs in with.
Issue keyRequiredtext
Order"created" or "-created"
Also give each comment as plain textJira stores a comment as a JSON document. This adds the words beside it as bodyText.
Also give Jira's own HTML renderingtrue/false
Comments per call1 to 100.
Fetch every pageWalks Jira's offset pages, and refuses past 5,000 comments.
CursorPaste a previous run's Next cursor to read the page after it.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `jira`)
issuetext
order"created" or "-created", by default "created"
plainTexttrue/false, by default true
renderedBodytrue/false, by default false
limitnumber, by default 100
returnAlltrue/false, by default false
cursortext

Output

FieldType
commentsarray
commentCountComments in this answernumber
totalComments Jira countednumber
hasMoreMore comments are waiting behind this pageboolean
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • commentCount0
  • comments[]
  • hasMorefalse
  • total0

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": {
    "connection": "<connection id>",
    "cursor": "",
    "issue": "<issue key>",
    "limit": 100,
    "order": "created",
    "plainText": true,
    "renderedBody": false,
    "returnAll": false
  },
  "label": "List comments",
  "type": "jira.listComments",
  "version": 2
}

Older versions

A flow that already has this version keeps running it. A new step always gets the newest.

Version 1
SettingWhat it is
ConnectionRequiredThe Jira connection the step signs in with.
Issue keyRequiredtext
Order"created" or "-created"
Also give each comment as plain textJira stores a comment as a JSON document. This adds the words beside it as bodyText.
Also give Jira's own HTML renderingtrue/false
Comments per call1 to 100.
Fetch every pageWalks Jira's offset pages, and refuses past 5,000 comments.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `jira`)
issuetext
order"created" or "-created", by default "created"
plainTexttrue/false, by default true
renderedBodytrue/false, by default false
limitnumber, by default 100
returnAlltrue/false, by default false