FlowmageDocs

Search issues

BetaReads dataVersion 2

Finds Jira issues with a JQL query.

Settings

SettingWhat it is
ConnectionRequiredThe Jira connection the step signs in with.
JQLRequiredJira refuses a query that is not bounded — one that is only an ORDER BY names no issues and is rejected. An ORDER BY may name at most 7 fields.
Fields to fetchJira returns nothing you do not ask for.
Expandtext
Name custom fields by their keytrue/false
Include archived projectstrue/false
Issues per call1 to 100.
Fetch every pageFollows Jira's next-page token until it stops sending one. At Pages at most or 5,000 issues it stops and answers the token to continue from. A token expires after 7 days, so one carried across a parked run is dead.
Pages at most1 to 100.
Also count the matchesJira no longer returns a total from a search, so this costs one extra call and the number it gives is approximate.
CursorPaste a previous run's Next cursor to read the page after it.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `jira`)
jqltext
fieldstext, by default "summary,status,assignee,priority,updated"
expandtext
fieldsByKeystrue/false, by default false
includeArchivedProjectstrue/false, by default false
limitnumber, by default 50
returnAlltrue/false, by default false
maxPagesnumber, by default 20used when `returnAll` is true
withCounttrue/false, by default false
cursortext

Output

FieldType
issuesarray
issueCountIssues in this answernumber
hasMoreMore issues are waiting behind this pageboolean
nextPageJira's token for the next pagestring
approximateTotalAbout how many match (when asked for)number
pagesRequests this read tooknumber
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • approximateTotal0
  • hasMorefalse
  • issueCount0
  • issues[]
  • nextPage""
  • pages1

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": "",
    "expand": "",
    "fields": "summary,status,assignee,priority,updated",
    "fieldsByKeys": false,
    "includeArchivedProjects": false,
    "jql": "<jql>",
    "limit": 50,
    "maxPages": 20,
    "returnAll": false,
    "withCount": false
  },
  "label": "Search issues",
  "type": "jira.searchIssues",
  "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.
JQLRequiredJira refuses a query that is not bounded — one that is only an ORDER BY names no issues and is rejected. An ORDER BY may name at most 7 fields.
Fields to fetchJira returns nothing you do not ask for.
Expandtext
Name custom fields by their keytrue/false
Include archived projectstrue/false
Issues per call1 to 100.
Fetch every pageFollows Jira's next-page token until it stops sending one. At Pages at most or 5,000 issues it stops and answers the token to continue from. A token expires after 7 days, so one carried across a parked run is dead.
Pages at most1 to 100.
Also count the matchesJira no longer returns a total from a search, so this costs one extra call and the number it gives is approximate.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `jira`)
jqltext
fieldstext, by default "summary,status,assignee,priority,updated"
expandtext
fieldsByKeystrue/false, by default false
includeArchivedProjectstrue/false, by default false
limitnumber, by default 50
returnAlltrue/false, by default false
maxPagesnumber, by default 20used when `returnAll` is true
withCounttrue/false, by default false