How to Search for work items using Grid Custom Field data in JQL Query
This page describes how to search for work items using Grid Custom Field data in JQL.
By default, JQL helps to search issues in Jira. With Table Grid, you can search issues by the content of a grid custom field. You can search by the whole string, part of the text, date, time or number.
You can search data only for indexed columns. To index data in a column check the Index data checkbox when configuring a column.
Syntax
Use in grids as a JQL function to search by the grid's content. Check the syntax below.
All search values are case sensitive. So, if you have a grid named Grid 1 with a column named Column 1, the query and column name in your search query should look like this:
issue in grids("Grid 1", "Column 1 = <search value>")
Search query syntax
Search query syntax
issue in grids("<grid custom field name>", "<column name> <operator> <search value>")
Search by 2 parameters:
Search query syntax
issue in grids("<grid custom field name>", "<column name> <operator> <search value>","<column name> <operator> <search value>")
Search by 2 grids:
Search query syntax
issue in grids("<grid custom field name>", "<column name> <operator> <search value>") and issue in grid("<grid custom field name>", "<column name> <operator> <search value>")
Restricted words and characters
JQL search has a set of reserved characters:
space (" ") + . , ; ? | * / % ^ $ # @ [ ]If you want to use these characters in your search queries, you need to:
surround them with quote-marks (you can use either single quote-marks (
') or double quote-marks (")). For example:issue in grids(“Grid quotes”, version ~ "[example]")if you are searching a text and the character is on the list of reserved characters for text searches, surround them with two backslashes( \ ). For example:
issue in grids(“Grid quotes”, ”Summary ~ \[Jul 10]\ - Invoice pending review”)
You can't search for many special characters in text fields using this method.
Reference
Below you find a detailed description of the operators that are used for advanced searching within the grid's content. Each column type supports a set of the operators detailed in the table below.
Column type | Data format | Operator |
|---|---|---|
Date, Time, DateTime | Date: 2024-02-27 DateTime: 2024-02-19 10:00 Time: 2024-01-01 13:00 *Jira don’t support searching by only time, so we will need to add prefix 2024-01-01 in this case |
|
UserList, String, Formula, TextArea, Sequence | text |
|
SingleSelect | string |
|
Number, Integer | number |
|
Examples
Search issues by empty or not empty grids
You can search for all issues which contain a grid that is empty or is not empty. The grid is considered empty when it has not been modified.
JQL query example
JQL query example
"Grid 1" IS NOT EMPTY
JQL query example
"Grid 1" IS EMPTY
Search issues by data from the grid
Find all issues which have Checklist grid custom field with a column called Summary that includes text value Onboarding
issue in grids("Checklist", "Summary~Onboarding")
Find all issues which have Shopping Order grid custom field with the Price greater than 10
issue in grids("Shopping Order", "Price>10")