JQL aliases and functions (reference)
The instructions on this page may be out of date and this page is kept in place only as a historical reference.
Please go to to the new documentation page to see the newest JQL aliases and functions:
👉 https://jqlsearchextensions.atlassian.net/wiki/spaces/SEARCH/pages/3183870001 👈
The instructions on this page describe how to execute a JQL search using extensions from JQL Search Extensions.
JQL aliases added by the app are accessible from Jira advanced search. JQL functions are accessible from Extended Search screen or via Extended Search filters in Jira advanced search.
JQL Functions
Extended search functions are invoked just like standard JQL functions. They are autocompleted after you start typing issue in…
ExactTextMatch
JQL functions are accessible only from Extended Search
Matches issues that contain the text in the summary or description. Takes a case-sensitive text as an argument.
Example:issue in exactTextMatch("text")
ExactTextMatchCaseInsensitive
JQL functions are accessible only from Extended Search
Similar to exactTextMatch but is case insensitive.
Example:issue in exactTextMatchCaseInsensitive("tExT")
matches issues with TEXT, Text, tEXT etc.
WildcardMatch
JQL functions are accessible only from Extended Search
Matches issues with a field containing a specified text (case-sensitive). You can use the asterisk (*) to match any text.
Examples:issue in wildcardMatch("summary", "Hello*")
issue in wildcardMatch("fixVersion", "12.0*")
issue in wildcardMatch("labels", "*Marketing*")
issue in wildcardMatch("component", "Business*")
issue in wildcardMatch("category", "MyOrg*")
The star symbol can be placed anywhere in the text – you can even place more than one.
Regex
JQL functions are accessible only from Extended Search
Use the full power of regular expressions to match field values. Regular expressions are strict and case sensitive.
Examples:
issue in regex("summary", "^Hello.*")
matches issues with summaries starting withissue in regex("fixVersion", "12.[0-5]")
matches issues with versions from 12.0 to 12.5issue in regex("labels", "Marketing$")
matches issues with labels that end with Marketingissue in regex("component", "Business.*")
issue in regex("category", "MyOrg.*")
issue in regex("Acceptance checklist", "can proceed")
matches issues that have any checkbox with can proceed checkedissue in regex("Custom cascading select list", "- Georgia")
matches issues with a cascading select field with Georgia as a child value
EpicsOfChildrenInQuery
JQL functions are accessible only from Extended Search
For a given JQL subquery it finds the epics of the resulting issues.
Examples:
issue in epicsOfChildrenInQuery("'Team Name'='My great team'") and status='To Do'
finds my team’s epics that are still in progressissue in epicsOfChildrenInQuery("assignee=currentUser() AND updated>-1d")
finds epics of my issues that where updated over the last day
ChildrenOfEpicsInQuery
JQL functions are accessible only from Extended Search
For a given JQL subquery it finds the children of the resulting epics.
Examples:
issue in childrenOfEpicsInQuery("resolution is not empty") AND resolution is empty
finds issues in progress that belong to an epic which has finishedissue in childrenOfEpicsInQuery("fixVersion='21.0.1' AND component=UI AND labels='review'")
finds children of epics with particular version, component and label
LinkedIssuesOfQuery
JQL functions are accessible only from Extended Search
For a given JQL subquery and an optional link type, it finds issues linked to resulting issues.
issue in linkedIssuesOfQuery("project=ACME", "is blocked by")
finds issues that my project ACME is blocked byissue in linkedIssuesOfQuery("project=ACME", "blocks")
finds issues that project ACME blocksissue in linkedIssuesOfQuery("type=Epic AND status='To Do'")
finds issues that are linked in any way with epics that are in progress
ParentsOfSubtasksInQuery
JQL functions are accessible only from Extended Search
For a given JQL subquery it finds parents of resulting subtasks
Examples:
issue in parentsOfSubtasksInQuery("status='To Do'") and status='Done'
finds finished issues that have unfinished subtasksissue in parentsOfSubtasksInQuery("assignee=currentUser()")
finds parents of my subtasks
SubtasksOfParentsInQuery
JQL functions are accessible only from Extended Search
For a given JQL subquery it finds subtasks of resulting parent issues
Examples:
issue in subtasksOfParentsInQuery("status='Done'") and status='To Do'
finds subtasks that are in progress and have finished parentsissue in subtasksOfParentsInQuery("assignee=currentUser()")
finds subtasks of my issues
ParentsOfIssuesInQuery
JQL functions are accessible only from Extended Search
For a given JQL subquery it finds parents of resulting issues. It supports Advanced Roadmaps “Parent Link” and a standard Jira hierachy Epic → Story → Subtask.
Also have a look at ParentsOfIssuesInQueryRecursive.
Examples:
issue in parentsOfIssuesInQuery("project='ACME' and type=Epic")
finds all parents of epics in project ACME. Parents of epics are usually called Initiative.issue in parentsOfIssuesInQuery("assignee=currentUser()")
finds parents of all of my tickets.
ParentsOfIssuesInQueryRecursive
JQL functions are accessible only from Extended Search
For a given JQL subquery it finds issues in the hierarchy above the resulting issues up to an optional depth. It supports Advanced Roadmaps “Parent Link” and a standard Jira hierachy Epic → Story → Subtask.
Examples:
issue in parentsOfIssuesInQueryRecursive("project='ACME' and type=Epic")
finds all parents of epics in project ACME, and parents of parents, and so on. Parents of epics are usually called Initiative.issue in parentsOfIssuesInQuery("assignee=currentUser() and issueType in subtaskIssueTypes()", 2)
finds parents of my subtasks and epics of the parents, skips anything above epics.
ChildrenOfIssuesInQuery
JQL functions are accessible only from Extended Search
For a given JQL subquery it finds children of resulting issues. It supports Advanced Roadmaps “Parent Link” and a standard Jira hierachy Epic → Story → Subtask. Also have a look at ChildrenOfIssuesInQueryRecursive.
Examples:
issue in childrenOfIssuesInQuery("project='ACME' and type=Initiative")
finds all epics in initiatives in project ACME.issue in childrenOfIssuesInQuery("assignee=currentUser()")
finds children of all of my tickets.
ChildrenOfIssuesInQueryRecursive
JQL functions are accessible only from Extended Search
For a given JQL subquery it finds issues in the hierarchy below the resulting issues up to an optional depth. It supports Advanced Roadmaps “Parent Link” and a standard Jira hierachy Epic → Story → Subtask.
Examples:
issue in childrenOfIssuesInQueryRecursive("project='ACME' and type=Initiative")
finds all epics, stories and subtasks in initiatives in project ACME.issue in childrenOfIssuesInQueryRecursive("assignee=currentUser() and type=Initiative", 2)
finds epics and stories of all of my epics and skips the subtasks.
NextSprint
JQL functions are accessible only from Extended Search
Finds issues that are planned for the next sprint. Pass a Jira board name or board id as an argument.
issue in nextSprint("ACME board")
issue in nextSprint(10)
Only sprints that were originally created on the board are included in the search
PreviousSprint
JQL functions are accessible only from Extended Search
Finds issues that were part of a previous sprint. Pass a Jira board name or board id as an argument.
issue in previousSprint("ACME board")
issue in previousSprint(10)
Only sprints that were originally created on the board are included in the search
AddedToSprintAfterStart
JQL functions are accessible only from Extended Search
Finds issues that were added to the sprint after the sprint was started. Handy to identify a scope creep in the sprint.
Pass a Jira board name or board id as a first argument.
You can optionally pass a sprint name or sprint id as a second argument. By default the active sprint is used in the search.
issue in addedToSprintAfterStart("ACME board")
issues added after the current sprint was started
issue in addedToSprintAfterStart("ACME board", "ACME Sprint 5")
issues added after sprint 5 was started
issue in addedToSprintAfterStart(10, 55)
you can also use board and sprint ids
Only sprints that were originally created on the board are included in the search
Permissions and feature availability to users
JQL Search Extensions Extended Search screen is a global permission that controls a visibility of Extended search feature. By defaults this permission is granted to all Jira users.
- 1 JQL Functions
- 1.1 ExactTextMatch
- 1.2 ExactTextMatchCaseInsensitive
- 1.3 WildcardMatch
- 1.4 Regex
- 1.5 EpicsOfChildrenInQuery
- 1.6 ChildrenOfEpicsInQuery
- 1.7 LinkedIssuesOfQuery
- 1.8 ParentsOfSubtasksInQuery
- 1.9 SubtasksOfParentsInQuery
- 1.10 ParentsOfIssuesInQuery
- 1.11 ParentsOfIssuesInQueryRecursive
- 1.12 ChildrenOfIssuesInQuery
- 1.13 ChildrenOfIssuesInQueryRecursive
- 1.14 NextSprint
- 1.15 PreviousSprint
- 1.16 AddedToSprintAfterStart
- 1.17 Permissions and feature availability to users
- 2 JQL aliases
- 2.1 Searching for attachments
- 2.1.1 AttachmentContent
- 2.1.2 AttachmentsCount
- 2.1.3 AttachedByUser
- 2.1.4 AttachedOnDate
- 2.1.5 AttachmentExtension
- 2.1.6 AttachmentName
- 2.2 Searching for subtasks
- 2.2.1 ParentSummary
- 2.2.2 ParentPriority
- 2.2.3 ParentIssueType
- 2.2.4 ParentStatus
- 2.2.5 ParentStatusCategory
- 2.3 Searching for issues with subtasks
- 2.3.1 SubtasksCount
- 2.3.2 SubtaskSummary
- 2.3.3 SubtaskKey
- 2.3.4 SubtaskPriority
- 2.3.5 SubtaskIssueType
- 2.3.6 SubtaskStatus
- 2.3.7 SubtaskStatusCategory
- 2.4 Searching for comments
- 2.4.1 CommentsCount
- 2.4.2 CommentedByUser
- 2.4.3 CommentLastCreatedBy
- 2.4.4 CommentLastUpdatedBy
- 2.4.5 CommentedOnDate
- 2.4.6 CommentedUpdatedOnDate
- 2.4.7 CommentLastCreatedOnDate
- 2.4.8 CommentLastUpdatedOnDate
- 2.5 Searching for versions
- 2.5.1 AffectedVersionsArchived
- 2.5.2 AffectedVersionsReleased
- 2.5.3 AffectedVersionsOpened
- 2.5.4 AffectedVersionsCount
- 2.5.5 AffectedVersionReleaseDate
- 2.5.6 FixVersionsArchived
- 2.5.7 FixVersionsReleased
- 2.5.8 FixVersionsOpened
- 2.5.9 FixVersionsCount
- 2.5.10 FixVersionReleaseDate
- 2.6 Searching for links
- 2.6.1 LinksCount
- 2.6.2 LinkedBy
- 2.6.3 LinksIssue
- 2.6.4 LinkType
- 2.6.5 LinkedIssueStatus
- 2.6.6 LinkedIssueStatusCategory
- 2.6.7 LinkedIssueType
- 2.6.8 LinkedIssuePriority
- 2.6.9 LinksIssuesCount
- 2.6.10 LinkedByIssuesCount
- 2.6.11 LinkedByIssueProject
- 2.6.12 LinksIssueProject
- 2.7 Searching for remote links
- 2.7.1 RemoteLinkUrl
- 2.7.2 RemoteLinkUrlPartialMatch
- 2.7.3 RemoteLinkApplicationName
- 2.7.4 RemoteLinkApplicationType
- 2.7.5 RemoteLinkHost
- 2.7.6 RemoteLinkQuery
- 2.7.7 RemoteLinkPath
- 2.7.8 RemoteLinkTitle
- 2.7.9 RemoteLinkTitlePartialMatch
- 2.7.10 RemoteLinkRelationship
- 2.7.11 RemoteLinksCount
- 2.8 Searching for updates and time logs
- 2.8.1 UpdatedByUsersCount
- 2.8.2 UpdatedBy
- 2.8.3 TransitionedBy
- 2.8.4 LoggedTimeBy
- 2.8.5 UpdatedOnDates
- 2.8.6 LastUpdatedBy
- 2.9 Searching for projects
- 2.9.1 MovedProjects
- 2.9.2 MovedProjectsCount
- 2.10 Searching for field comparisons
- 2.10.1 HasSameUpdatedAndCreatedDate
- 2.10.2 HasSameAssigneeAndReporter
- 2.10.3 HasSameVersions
- 2.11 Epic
- 2.12 Note on aggregation of dates
- 2.13 Note on dates with time
- 2.1 Searching for attachments
JQL aliases
Searching for attachments
AttachmentContent
Search for issues that have attachments with the provided phrase. Search functionality will go find the provided phrase in PDF, Word (doc, docx), PowerPoint (ppt, pptx), Excel (xls and xslx), OpenOffice and PlainText.
Please keep in mind that it is sometimes impossible to extract text from files. Complex PDFs and Excel files are the most problematic. Having said that in over 99% of cases indexing is successful.
SUPPORTED OPERATORS
EXAMPLES
Find issues with attachments containing the phrase "specification".
1
attachmentContent ~ "specification"
AttachmentsCount
Search for issues that have a particular attachments number.
SUPPORTED OPERATORS
EXAMPLES
Find issues with attachments:
1
attachmentsCount > 0
AttachedByUser
Search for issues with attachments added by a particular user.
SUPPORTED OPERATORS
EXAMPLES
Find issues with attachments added by "Jane Potter".
1
attachedByUser = "Jane Potter"
AttachedOnDate
Search for issues with attachments added on a particular date. This JQL keyword works with date related JQL functions:
endOfDay()
endOfMonth()
endOfWeek()
endOfYear()
lastLogin()
now()
startOfDay()
startOfMonth()
startOfWeek()
startOfYear()
Also see:
SUPPORTED OPERATORS
|
|
EXAMPLES
Find issues with attachments attached on particular dates.
1
2
attachedOnDate >= "2016/03/14" and attachedOnDate < "2016/03/15"
attachedOnDate < now()
AttachmentExtension
Search for issues with attachments with a particular extension.
SUPPORTED OPERATORS
EXAMPLES
Find issues with attachments with PNG of JPG extensions.
1
attachmentExtension = "png" OR attachmentExtension = "jpg"
AttachmentName
Search for issues with attachments with a particular name.
SUPPORTED OPERATORS
EXAMPLES
Find issues with an attachment name containing "screenshot".
1
attachmentName ~ "screenshot"
Searching for subtasks
ParentSummary
Search for subtasks with a parent's summary containing a particular text.
SUPPORTED OPERATORS
EXAMPLES
Find subtasks which parents summary contains text "Test"
1
parentSummary ~ "Test"
ParentPriority
Search for subtasks with a parent of a particular Priority.
SUPPORTED OPERATORS
EXAMPLES
Find subtasks which parent is of a "Blocker" priority.
1
parentPriority = Blocker
ParentIssueType
Search for subtasks with a parent of a particular Issue Type.
SUPPORTED OPERATORS
EXAMPLES
Find subtasks with a parent of issue type "Test".
1
parentIssueType = "Test"
ParentStatus
Search for subtasks with a parent of a particular Status.
SUPPORTED OPERATORS
EXAMPLES
Find subtasks with a parent which is "In Progress".
1
parentStatus = "In Progress"
ParentStatusCategory
Search for subtasks with a parent of a particular Status Category.
SUPPORTED OPERATORS
EXAMPLES
Find subtasks with a parent in "To Do" status category.
1
parentStatusCategory= "To Do"
Searching for issues with subtasks
SubtasksCount
Search for issues that have a particular number of subtasks.
SUPPORTED OPERATORS
EXAMPLES
Find issues with subtasks
1
subtasksCount > 0
SubtaskSummary
Search for issues that have subtasks where summary contains particular text.
SUPPORTED OPERATORS
EXAMPLES
Find issues which subtasks summary contains text "Test"
1
subtaskSummary ~ "Test"
SubtaskKey
Search for issues that have subtasks with a particular key.
SUPPORTED OPERATORS
EXAMPLES
Find issues with subtask with key ABC-123
1
subtaskKey = ABC-123
SubtaskPriority
Search for issues that have subtasks with a particular Priority.
SUPPORTED OPERATORS
EXAMPLES
Find issues with subtasks which have a "Blocker" priority.
1
subtaskPriority = Blocker
SubtaskIssueType
Search for issues that have subtasks with a particular Issue Type.
SUPPORTED OPERATORS
EXAMPLES
Find issues with subtasks of issue type "Test".
1
subtaskIssueType = "Test"
SubtaskStatus
Search for issues that have subtasks with a particular Status.
SUPPORTED OPERATORS
EXAMPLES
Find issues which have subtasks "In Progress".
1
subtaskStatus = "In Progress"
SubtaskStatusCategory
Search for issues that have subtasks with a particular Status Category.
SUPPORTED OPERATORS
EXAMPLES
Find issues which have "To Do" status category.
1
subtaskStatusCategory = "To Do"
Searching for comments
CommentsCount
Search for issues that have a particular number of comments.
SUPPORTED OPERATORS
EXAMPLES
Find issues with comments
1
commentsCount > 0
CommentedByUser
Search for issues that were commented by a particular user.
SUPPORTED OPERATORS
EXAMPLES
Find issues which were commented by Jane Potter.
1
commentedByUser = "Jane Potter"
CommentLastCreatedBy
Search for issues that were last commented by a particular user.
SUPPORTED OPERATORS
EXAMPLES
Find issues which were last commented by admin.
1
commentLastCreatedBy= "admin"
CommentLastUpdatedBy
Search for issues with a comment last updated by a particular user.
SUPPORTED OPERATORS
EXAMPLES
Find issues with a comment last updated by admin.
1
commentLastUpdatedBy= "admin"
CommentedOnDate
Search for issues which were commented on a particular date. This keyword works with date related JQL functions:
endOfDay()
endOfMonth()
endOfWeek()
endOfYear()
lastLogin()
now()
startOfDay()
startOfMonth()
startOfWeek()
startOfYear()
Also see:
SUPPORTED OPERATORS
|
EXAMPLES
Find issues which were commented on 13th or 14th of March, 2016
1
2
commentUpdatedDate >= "2016/03/13" AND commentUpdatedDate < "2016/03/15"
commentedOnDate < now()
CommentedUpdatedOnDate
Search for issues which comment was updated on a particular date. This keyword works with date related JQL functions:
endOfDay()
endOfMonth()
endOfWeek()
endOfYear()
lastLogin()
now()
startOfDay()
startOfMonth()
startOfWeek()
startOfYear()
Also see:
SUPPORTED OPERATORS
|
EXAMPLES
Find issues with comments updated on 13th or 14th of March, 2016
1
2
commentUpdatedDate >= "2016/03/13" AND commentUpdatedDate < "2016/03/15"
commentUpdatedDate < now()
CommentLastCreatedOnDate
Search for issues which were last commented on a particular date. This keyword works with date related JQL functions:
endOfDay()
endOfMonth()
endOfWeek()
endOfYear()
lastLo