On this page
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
The following list contains all the available functions that work with all kinds of lists: text, number and issue lists.
| Function | Short description | Output |
|---|---|---|
| append() | Combines the elements of two lists. | NUMBER LIST TEXT LIST ISSUE LIST |
| avg() | Calculates the average values of a given number list. | NUMBER |
| count() | Returns the number of elements in a text, number or issue list. | NUMBER |
| distinct() | Removes all duplicates from a number, text, or issue list. | NUMBER LIST TEXT LIST ISSUE LIST |
| epic() | Returns all epics linked to specified issues. | ISSUE LIST |
| except() | Removes certain elements from a list. | NUMBER LIST TEXT LIST ISSUE LIST |
| filterByCardinality() | Filters a given number, text, or issue list by the number of occurrence of elements. | 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 |
| getMatchingValue() | Returns a custom reference value for a given or text or number. | NUMBER TEXT |
| intersect() | Returns common elements of two lists. | NUMBER LIST TEXT LIST ISSUE LIST |
| issuesFromJQL() | Returns a list of issues returned by a specified JQL query. | ISSUE LIST |
| issuesUnderEpic() | Returns all issues linked to a given epic | ISSUE LIST |
| last() | Returns the last element of a number, text, or issue list. | NUMBER TEXT ISSUE LIST |
| linkedIssues() | Returns a list of issues linked. | ISSUE LIST |
| max() | Returns the highest value in a number list. | NUMBER |
| min() | Returns the smallest value in a number list. | NUMBER |
| nthElement() | Returns the nth element of a number, text or issue list. | NUMBER TEXT ISSUE LIST |
| siblingIssuesUnderEpic() | Returns all issues linked to a given epic | ISSUE LIST |
| sort() | Sorts a given list in a specific order. | NUMBER LIST TEXT LIST ISSUE LIST |
| sublist() | Returns a defined extract of a given list. | NUMBER LIST TEXT LIST ISSUE LIST |
| subtasks() | Returns the list of sub-tasks of the specified issue(s). | ISSUE LIST |
| sum() | Sums up all values in a given number list. | NUMBER |
| union() | Returns distinct elements of two lists. | NUMBER LIST TEXT LIST ISSUE LIST |
The following list contains all the available functions that work with number lists only.
The following list contains all the available functions that work with issue lists only.
| Function | Short description | Output |
|---|---|---|
| epic() | Returns all epics linked to specified issues. | ISSUE LIST |
| fieldValue() | Returns a number or text list with field values. | NUMBER LIST TEXT LIST |
| filterByIssueType() | Filters a given issue list by issue type. | ISSUE LIST |
| filterByProject() | Filters a given issue list by project. | ISSUE LIST |
| filterByResolution() | Filters a given issue list by resolution. | ISSUE LIST |
| filterByStatus() | Filters a given issue list by issue status. | 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 |
| subtasks() | Returns the list of sub-tasks of the specified issue(s). | ISSUE LIST |
If you still have questions, feel free to refer to our support team.
