JQL Library - Reference
Description
This document describes the functions and properties of the App.
Reference
JQL Function/Property syntax | Description | Type | Arguments/Operators | Example | |
|---|---|---|---|---|---|
| 1 | Subtasks: |
|
|
|
|
| 2 | issue in jqllib_subtaskParents(jql) | Find the parents to the subtasks retrieved by the jql. The JQL given is executed, where resulting issues are filtered for subtasks. | function | Jql query clause must be provided | Find the parents of subtasks in project SCRUM: issue in jqllib_subtaskParents("project = SCRUM") |
| 3 | issue in jqllib_subtaskParentsRecursive(jql, depth) | Find the parents to the subtasks retrieved by the jql (like above function, but recursive upwards). Supports Advanced roadmaps (parent) | function | Jql query clause must be provided. Argument depth (integer) must be given. | Find the parents upwards of subtasks in project SCRUM, but a maximum level of 5: issue in jqllib_subtaskParentsRecursive("project = SCRUM", 5) |
| 4 | jqllib_subtaskCount | Find issues that has the number of subtasks/child issues (this includes children from e.g. Epics) | number | number operators (see below) | jqllib_subtaskCount = 2 |
| 5 | jqllib_subtaskKey | Find issues that has a subtask/child with the given issue key (by operator) | string | string operators (see below) | jqllib_subtaskKey = SCRUM-704 |
| 6 | jqllib_subtaskSummary | Find issues that has a subtask/child with the given issue summary (by operator) | text | text operators | jqllib_subtaskSummary ~ "a summary of a subtask" |
| 7 | jqllib_subtaskStatus | Find issues that has a subtask/child with the given status (by operator) | string | string operators | jqllib_subtaskStatus = "To do |
| 8 | jqllib_subtaskStatusCategory | Find issues that has a subtask/child with the given status category (by operator) | string | string operators | jqllib_subtaskStatusCategory = "In Progress" |
| 9 | jqllib_subtaskPriority | Find issues that has a subtask/child with the given priority (by operator) | string | string operators | jqllib_subtaskPriority = Medium |
| 10 | jqllib_subtaskIssuetype | Find issues that has a subtask/child with the given issue type (by operator) | string | string operators | jqllib_subtaskIssuetype = Task |
| 11 | Parents and children: | ||||
| 12 | issue in jqllib_parentsOf("jql..") | Find issues that are parents of the jql provided | function | jql clause must be given | issue in jqllib_parentsOf("project = 'AS' and issuetype = Sub-task") |
| 13 | issue in jqllib_parentsOfRecursive("jql..", depth) | Find issues that are parents (recursive up) of the jql provided, up to the maximum depth (provided) | function | jql clause and depth (integer) must be given | issue in jqllib_parentsOfRecursive("project = 'AS' and issuetype = Sub-task",5) |
| 14 | issue in jqllib_children(jql) | Find the immediate children of issues determined by the jql argument. | function | issue in .. | issue in jqllib_children("issue = EPICS-2") |
| 15 | issue in jqllib_childrenRecursive(jql, depth) | Find the immediate children of issues determined by the jql argument, recursive down (max to depth). | function | issue in .. | issue in jqllib_childrenRecursive("issue = EPICS-2", 4) |
| 16 | jqllib_parentKey | Find issues that has a parent with the given issue key | string | string operators | jqllib_parentKey = SCRUM-500 |
| 17 | jqllib_parentSummary | Find issues that has a parent with the given summary | text | text operators | jqllib_parentSummary ~ "A summary of a parent" |
| 18 | jqllib_parentStatus | Find issues that has a parent with the given status | string | string operators | jqllib_parentStatus = "To do" |
| 19 | jqllib_parentStatusCategory | Find issues that has a parent with the given status category | string | string operators | jqllib_parentStatusCategory = "In Progress" |
| 20 | jqllib_parentPriority | Find issues that has a parent with the given priority | string | string operators | jqllib_parentPriority = Medium |
| 21 | jqllib_parentIssuetype | Find issues that has a parent with the given issue type | string | string operators | jqllib_parentIssuetype = Task |
| 22 | Attachments: | ||||
| 23 | jqllib_attachmentCount | Find issues that has the given number of attachments | number | number operators | jqllib_attachmentCount > 2 |
| 24 | jqllib_attachmentFilename | Find issues with attachments filtered by given filename | text | text operators | jqllib_attachmentFilename ~ "Document.docx" |
| 25 | jqllib_attachmentExtension | Find issues with attachments that has the given extension (note, do not start with punctuation) | string | string operators | jqllib_attachmentExtension = "pdf |
| 26 | jqllib_attachmentSize | Find issues with attachments smaller/larger than size (note: Megabytes) | number | number operators | jqllib_attachmentSize > 10 |
| 27 | jqllib_attachmentCreated | Find issues with attachments created before/after given date | date | date operators | jqllib_attachmentCreated > startOfYear() |
| 28 | jqllib_attachmentAuthorAccountId | Find issues with attachments uploaded by given user | user | user operators | jqllib_attachmentAuthorAccountId = currentUser() |
| 29 | jqllib_attachmentAuthorDisplayName | Find issues with attachments updated by user (by display name) | text | text operators | jqllib_attachmentAuthorDisplayName ~ 'John' |
| 30 | Comments: | ||||
| 31 | jqllib_commentCount | Find issues with comment count, filtered by operator | number | number operators | jqllib_commentCount > 0 |
| 32 | jqllib_commentAuthorAccountId | Find issues that has a comment by a specific author | user | user operators | jqllib_commentAuthorAccountId = currentUser() |
| 33 | jqllib_commentAuthorDisplayName | Find issues that has a comment by a specific author | text | text operators | jqllib_commentAuthorDisplayName = 'Jeremy' |
| 34 | jqllib_commentCreated | Find issues with any comment created filtered by operator | date | date operators | jqllib_createdUpdated >= startOfDay() and jqllib_createdUpdated <= endOfDay() |
| 35 | jqllib_commentUpdated | Find issues with any comment updated filtered by operator | date | date operators | jqllib_commentUpdated >= startOfDay() and jqllib_commentUpdated <= endOfDay() |
| 36 | jqllib_commentLastCreatedOnDate | FInd issues that were last commented on a specific date (by operator) | date | date operators | jqllib_commentLastCreatedOnDate > startOfDay() |
| 37 | jqllib_commentLastUpdatedOnDate | FInd issues with the last comment updated on a specific date (by operator) | date | date operators | jqllib_commentLastUpdatedOnDate > startOfDay() |
| 38 |
|
|
|
|
|
| 39 | Operator explanation | ||||
| 40 | Number operators: | =, !=, <=, >=, >, <, IS, IS NOT, IN, NOT IN |
| Read more here: https://support.atlassian.com/jira-software-cloud/docs/jql-operators/ |
|
| 41 | String operators: | =, !=, IS, IS NOT, IN, NOT IN |
|
|
|
| 42 | Text operators: | ~, !~, IS, IS NOT |
|
|
|
| 43 | Date operators: | =, !=, <=, >=, >, <, IS, IS NOT, IN, NOT IN |
|
|
|
| 44 |
| Dates can be used together with functions currentlogin(), endOfDay(), endOfMonth(), endOfYear(), endOfWeek(), lastLogin(), now(), startOfDay, startOfWeek(), startOfYear(), startOfMonth() and more |
|
|
|
| 45 | User operators: | =, !=, IS, IS NOT, IN, NOT IN |
|
|
|
| 46 |
| User operators can be used together with currentUser() |
|
|
|