JQL Functions
RegEx Evaluator
FieldValueMatches("Field_Name", "Regex_Pattern") |
Items | Explanation |
---|---|
JQL: FieldValueMatches | Return all the issues whose specific field value matches the "Regex_Pattern" |
JQL Context | issue in, issue not in |
Field_Name | Support any text-based fields. i.e. "Summary", "Description", ' text field (single line)', etc. |
Regex_Pattern | Support any regular expression patterns |
JQL Example | issue in FieldValueMatches("summary", "[hm]at") will return all the issues whose summary contains hat or mat |
Previous Status* REVIEW jql example. are quotes needed around spaced status names?
preStatusWas("status_A") preStatusContainsAll("status_A, status_B, status_C,..., status_X") preStatusContainsEither("status_A, status_B, status_C,..., status_X") |
Items | Explanation |
---|---|
preStatusWas | Return all the issues whose most recently previous status is status_A |
preStatusContainsAll | Return all the issues whose historical statuses (excluding current status) include status_A and status_B and status_C and ... and status_X |
preStatusContainsEither | Return all the issues whose most recently previous status is status_A or status_B or status_C or ... or status_X |
JQL Context | issue in/not in |
status_X | Support all Jira workflow statuses |
JQL Example | Four example issues with their workflow transition history:
'issue in preStatusWas("Rejected")' will return TK-4 |
Automating high volume queries may result in performance degradation of your Jira instance. It is recommend that the StatusWas JQL statements are used ad-hoc, and not for automation or high-volume workflow actions.
Date Comparisons
datesWithin("Time_Frame", "Date_Field_Name_1", "Date_Field_Name_2") datesBeyond("Time_Frame", "Date_Field_Name_1", "Date_Field_Name_2") dateTimeWithin("Time_Frame", "DateTime_Field_Name_1", "DateTime_Field_Name_2") dateTimeBeyond("Time_Frame", "DateTime_Field_Name_1", "DateTime_Field_Name_2") |
Items | Explanation |
---|---|
datesWithin | Return all the issues whose time difference between "Date_Field_Name_1" and "Date_Field_Name_2" is less than or equal to "Time_Frame" |
datesBeyond | Return all the issues whose time difference between "Date_Field_Name_1" and "Date_Field_Name_2" is greater than or equal to "Time_Frame" |
dateTimeWithin | Return all the issues whose time difference between "DateTime_Field_Name_1" and "DateTime_Field_Name_2" is less than or equal to "Time_Frame" |
dateTimeBeyond | Return all the issues whose time difference between "DateTime_Field_Name_1" and "DateTime_Field_Name_2" is greater than or equal to "Time_Frame" |
JQL Context | issue in/not in |
Time_Frame | Time frame can be w, d, h, m and separated by spaces.
Example: "1w 2d 3h 4m" |
Date_Field_Name_1&2 | Supports
and any other Date Picker custom fields |
DateTime_Field_Name_1&2 | Supports
and any other DateTime Picker custom fields |
JQL Example | issue in dateTimeWithin("3d 8h", "created", "updated") |
Issue Link Types
issueLinkType("Issue_Link_Type") |
Items | Explanation |
---|---|
issueLinkType | Return all the issues that have a certain type of issue link |
JQL Context | issue in/not in |
Issue_Link_Type | Support all issue link types. i.e. "blocks", "is blocked by", "duplicates", "relates to" etc. |
JQL Example | 'issue in issueLinkType("clones")' will return all the issues whose issue link type is "clones" |
Members of Role
membersOfRole("Project_Role") |
Items | Explanation |
---|---|
membersOfRole | Return all the issues where a specified user is in a specific project role. |
JQL Context |
|
Project_Role | Support all Jira project roles |
JQL Example | assignee in membersOfRole("Administrators") |
Time in Status
timeWithin("Time_Frame", "Status_A", "Status_B", "Status_C") timeBeyond("Time_Frame", "Status_A", "Status_B", "Status_C") |
Items | Explanation |
---|---|
timeWithin | Return all the issues whose sum of time spent in certain statuses is less than or equal to "Time_Frame"
|
timeBeyond | Return all the issues whose sum of time spent in certain statuses is greater than or equal to "Time_Frame"
|
JQL Context | issue in/not in |
Time_Frame | Time frame can be w, d, h, m, s and separated by spaces.
Example: "1w 2d 3h 4m 5s" |
status_A&B&C | Support all Jira workflow statuses |
JQL Example | issue in timeWithin("1h", "In Progress") issue in timeBeyond("1d 2h 30s", "Open") |
Linked to Epic
epicTree("Epic_Issue_Key_1", "Epic_Issue_Key_2", ..., "Epic_Issue_Key_N") |
Items | Explanation |
---|---|
epicTree | Return all epics with those given epic issue keys, all issues linked to those epics and all sub-tasks of those issues linked to the epics
|
JQL Context | issue in/not in |
Arg: Epic_Issue_Key_N | Support all Jira Epic issue keys |
JQL Example | issue in epicTree("Data Storage", "System Config", "Security") |