This page contains a comprehensive overview of all list related information.
The list data type is an ordered list of elements. Those elements have a certain data type (text or number).
It's possible
-
to access individual elements (e.g. using the function nthElement()),
-
to create lists out of virtual fields (e.g. using toStringList()) or
-
to use the list functions presented on this page to work with lists.
Fixed values
A list can be written in literal form using the following format: [element1,element2,...elementN].
Examples
-
A text list with 5 elements:
["Blue", "Green", "Yellow", "Orange", "Red"] -
A number list with 1 element:
[3.14] -
A number list with 3 elements using field codes and functions:
[1, {issue.subtasks.length}, length(linkedIssues())] -
An empty list: []
Available functions
All functions
The following list contains all the available functions that work with all kinds of lists: text, number and issue lists.
| Function | Short description | Output |
|---|---|---|
| count() |
Returns the number of elements in a text, number or issue list. |
number |
| union() |
Returns distinct elements of two lists. |
number list text list issue list |
| filterByValue() |
Filters a number or text list using a given comparison. |
number list text list |
| first() |
Returns the first element of a number, text, or issue list. |
number text issue list |
| last() |
Returns the last element of a number, text, or issue list. |
number text issue list |
| max() |
Returns the highest value in a number list. |
number |
| sort() |
Sorts a given list in a specific order. |
number list text list issue list |
| intersect() |
Returns common elements of two lists. |
number list text list issue list |
| except() |
Removes certain elements from a list. |
number list text list issue list |
| siblingIssuesUnderEpic() |
Returns all issues linked to a given epic |
issue list |
| issuesUnderEpic() |
Returns all issues linked to a given epic |
issue list |
| nthElement() |
Returns the nth element of a number, text or issue list. |
number text issue list |
| sublist() |
Returns a defined extract of a given list. |
number list text list issue list |
| epic() |
Returns all epics linked to specified issues. |
issue list |
| subtasks() |
Returns the list of sub-tasks of the specified issue(s). |
issue list |
| distinct() |
Removes all duplicates from a number, text, or issue list. |
number list text list issue list |
| avg() |
Calculates the average values of a given number list. |
number |
| min() |
Returns the smallest value in a number list. |
number |
| filterByCardinality() |
Filters a given number, text, or issue list by the number of occurrence of elements. |
number list text list issue list |
| append() |
Combines the elements of two lists. |
number list text list issue list |
| sum() |
Sums up all values in a given number list. |
number |
| parent() |
Returns the direct parent(s) of the given issue(s) according to configured hierarchy. |
issue list |
| getMatchingValue() |
Returns a custom reference value for a given or text or number. |
number text |
| issuesFromJQL() |
Returns a list of issues returned by a specified JQL query. |
issue list |
| linkedIssues() |
Returns a list of issues linked. |
issue list |
Number list functions
The following list contains all the available functions that work with number lists only.
Issue list functions
The following list contains all the available functions that work with issue lists only.
| Function | Short description | Output |
|---|---|---|
| filterByResolution() |
Filters a given issue list by resolution. |
issue list |
| filterByStatus() |
Filters a given issue list by issue status. |
issue list |
| filterByIssueType() |
Filters a given issue list by issue type. |
issue list |
| epic() |
Returns all epics linked to specified issues. |
issue list |
| subtasks() |
Returns the list of sub-tasks of the specified issue(s). |
issue list |
| filterByProject() |
Filters a given issue list by project. |
issue list |
| issuesFromJQL() |
Returns a list of issues returned by a specified JQL query. |
issue list |
| linkedIssues() |
Returns a list of issues linked. |
issue list |
| fieldValue() |
Returns a number or text list with field values. |
number list text list |