[DC] JQL Functions
Functions by type
- 1 User
- 2 Group
- 3 Component
- 4 Project
- 5 Project Category
- 6 Development
- 6.1 hasCommits()
- 6.2 hasBranches()
- 6.3 hasBuilds()
- 6.4 hasFailBuilds()
- 6.5 hasPassBuilds()
- 6.6 hasDeclinedPR()
- 6.7 hasMergedPR()
- 6.8 hasOpenPR()
- 6.9 hasPR()
- 6.10 hasSuccessDeploy()
- 7 Date
- 7.1 startOfQuarter()
- 7.2 endOfQuarter()
- 7.3 startOfHalf()
- 7.4 endOfHalf()
User
membersOfGroups(group1, group2, groupK)
The function membersOfGroups(group1, group2, groupK) appears to be a method for retrieving members from multiple groups. It likely takes in several group identifiers as parameters and returns a collection of members belonging to those specified groups.
Syntax | membersOfGroups(group1, group2, groupK) |
|---|---|
Supported fields | Assignee, Reporter, Voter, Watcher, custom fields of type User |
Supported operators |
|
Unsupported operators |
|
Examples |
|
usersInRole(project, role)
The function usersInRole(project, role) is likely designed to retrieve a list of users assigned to a specific role within a given project. This could be useful for managing team responsibilities and ensuring that the right individuals are involved in various aspects of the project. The function's parameters include project, which identifies the project in question, and role, which specifies the particular role for which users are being queried.
Syntax | usersInRole(project, role) |
|---|---|
Supported fields | Assignee, Reporter, Voter, Watcher, custom fields of type User |
Supported operators |
|
Unsupported operators |
|
Examples |
|
userMatch(pattern*)
Syntax | userMatch(pattern*) |
|---|---|
Supported fields | Assignee, Reporter, Voter, Watcher, custom fields of type User |
Supported operators |
|
Unsupported operators |
|
Examples |
|
projectLeads(project1, project2)
projectLeads(project1, project2)-
Syntax | projectLeads(project1, project2) |
|---|---|
Supported fields | Assignee, Reporter, Voter, Watcher, custom fields of type User |
Supported operators |
|
Unsupported operators |
|
Examples |
|
inactiveUsers(key|username|display name|email)
Syntax | inactiveUsers(key|username|display name|email) |
|---|---|
Supported fields | Assignee, Reporter, Voter, Watcher, custom fields of type User |
Supported operators |
|
Unsupported operators |
|
Examples |
|
componentLeads(project, component1, component2)
Syntax | componentLeads(project, component1, component2) |
|---|---|
Supported fields | Assignee, Reporter, Voter, Watcher, custom fields of type User |
Supported operators |
|
Unsupported operators |
|
Examples |
|
jsmUsers()
The function jsmUsers() is designed to retrieve user data from the system. It plays a crucial role in managing user information efficiently. By calling this function, developers can access a comprehensive list of users, which can then be utilized for various purposes such as analytics, reporting, or user management tasks.
Syntax | jsmUsers() |
|---|---|
Supported fields | Assignee, Reporter, Voter, Watcher, custom fields of type User |
Supported operators |
|
Unsupported operators |
|
Examples |
|
jswUsers()
Syntax | jswUsers() |
|---|---|
Supported fields | Assignee, Reporter, Voter, Watcher, custom fields of type User |
Supported operators |
|
Unsupported operators |
|
Examples |
|
usersWithProperty('color', 'red')
Syntax | usersWithProperty('color', 'red') |
|---|---|
Supported fields | Assignee, Reporter, Voter, Watcher, custom fields of type User |
Supported operators |
|
Unsupported operators |
|
Examples |
|
Group
groupsOfUser(user)
groupsOfUser(user) is a custom JQL function that returns a list of Jira groups that a specific user belongs to. This function is useful for filtering issues based on group membership.
Syntax | groupsOfUser(user) |
|---|---|
Supported fields | Custom fields of type Group |
Supported operators |
|
Unsupported operators |
|
Examples | group IN groupsOfUser("john.doe")This query retrieves all groups that the user john.doe is a member of. group IN groupsOfUser(currentUser()) This query retrieves all groups for the currently logged-in user. Parameters:
Use Cases:
|
groupMatch(pattern)
groupMatch(pattern) is a custom JQL function that allows you to filter and retrieve groups based on a pattern match in Jira. It helps find groups whose names match a specified pattern, making it easier to work with groups that follow a specific naming convention.
Syntax | groupMatch(pattern) |
|---|---|
Supported fields | Custom fields of type Group |
Supported operators |
|
Unsupported operators |
|
Examples | group IN groupMatch("dev*")
This query retrieves all groups whose names start with "dev", such as "dev-team", "dev-ops", etc. Parameters:
Use Cases:
|
Component
componentMatch(pattern)
componentMatch(pattern) is a custom JQL function used to filter components in Jira based on a pattern match for the component name. It allows you to search for components whose names match the specified pattern, making it easier to find components without needing to list each one explicitly.
Syntax | componentMatch(pattern) |
|---|---|
Supported fields | Component |
Supported operators |
|
Unsupported operators |
|
Examples | component IN componentMatch("Backend*")
This query retrieves all components whose names start with "Backend", such as "Backend API", "Backend Services", etc. Parameters:
Use Cases:
|
activeComponents('PRJ', 'INT', 'DEV')
activeComponents('PRJ', 'INT', 'DEV') is a custom JQL function used to filter components that are active in specific projects. This function retrieves components that are currently active (not archived) within the specified projects.
Syntax | activeComponents('PRJ', 'INT', 'DEV') |
|---|---|
Supported fields | Component |
Supported operators |
|
Unsupported operators |
|
Examples | component IN activeComponents('PRJ', 'INT', 'DEV')This query retrieves all active components within the projects PRJ, INT, and DEV. Parameters:
Use Cases:
|
archivedComponents('PRJ', 'INT', 'DEV')
archivedComponents('PRJ', 'INT', 'DEV') is a custom JQL function that filters components in archived projects. This function allows you to search for components that have been archived within specified projects.
Syntax | archivedComponents('PRJ', 'INT', 'DEV') |
|---|---|
Supported fields | Custom fields of type Group |
Supported operators |
|
Unsupported operators |
|
Examples | component IN archivedComponents('PRJ', 'INT', 'DEV')This query retrieves all components that have been archived within the specified projects: PRJ, INT, and DEV. Parameters:
Use Cases:
|
Project
projectMatch(pattern)
projectMatch(pattern) is a custom JQL function designed to filter projects by matching patterns in their names. This function proves invaluable for dynamically selecting projects that adhere to specific naming conventions, eliminating the need to list each project individually.
Syntax | projectMatch(pattern) |
|---|---|
Supported fields | Project |
Supported operators |
|
Unsupported operators |
|
Examples | project IN projectMatch("HR*")This query retrieves all projects with names that begin with "HR", including examples like "HR System" and "HR Requests". Parameters:
Use Cases:
|
projectWithUserInRole(user, projectRole)
projectWithUserInRole(user, projectRole) is a custom JQL function that returns a list of projects where a specified user has a given project role.
Syntax | projectWithUserInRole(user, projectRole) |
|---|---|
Supported fields | Project |
Supported operators |
|
Unsupported operators |
|
Examples | This query retrieves all projects where the current user has the role "Developers". Parameters:
Use Cases:
|