Searching ToDo Items

This page describes information about functions that are used for advanced searching for Todo field.

A function in JQL appears as a word followed by parentheses, which may contain one or more explicit values or Jira fields. In a clause, a function is preceded by an operator, which in turn is preceded by a field. A function performs a calculation on either specific Jira data or the function's content in parentheses, such that only true results are retrieved by the function, and then again by the clause in which the function is used.

JQL Function for ToDo field

allItemsDone()

Allows to search the issues where all todo items are done.

Syntax

1 allItemsDone()

Supported fields

ToDo custom field

Supported operators

=, !=

Unsupported operators

~ , !~ , > , >= , < , <= IS , IS NOT , WAS , WAS NOT , CHANGED, IN , NOT IN , WAS IN , WAS NOT IN

Examples

  • Search issues where the items of ToDo List field are done:
    "ToDo List" = allItemsDone()

allItemsUndone()

Allows to search the issues where all todo items are undone.

Syntax

1 allItemsUndone()

Supported fields

ToDo custom field

Supported operators

=, !=

Unsupported operators

~ , !~ , > , >= , < , <= IS , IS NOT , WAS , WAS NOT , CHANGED, IN , NOT IN , WAS IN , WAS NOT IN

Examples

  • Search issues where the items of ToDo List field are undone:
    "ToDo List" = allItemsUndone()

todoItem()

Allows to search the issues where all todo items have status and/or name and/or they are done/undone.

Syntax

1 todoItem(status, itemName, done/undone)

Supported fields

ToDo custom field

Supported operators

=, !=

Unsupported operators

~ , !~ , > , >= , < , <= IS , IS NOT , WAS , WAS NOT , CHANGED, IN , NOT IN , WAS IN , WAS NOT IN

Examples

  • Search issues where one of all items of ToDo List field has “New” status:
    "ToDo List" = todoItem("New", "", "")

  • Search issues where item name of ToDo List field is “Check a license“ :
    "ToDo List" = todoItem("", "Check a license", "")

  • Search issues where one of all items of ToDo List field is undone:
    "ToDo List" = todoItem("", "", "undone")

  • Search issues where one of all items of ToDo List field is done and has status “Awaiting for Check“:"ToDo List" = todoItem("Awaiting for Check", "", "done")

Search by date

Allows to search the issues where todo item has date before, or after a particular date (or date range).

Syntax

1 Name of Todo Field, e.g. "ToDo List"

Supported fields

ToDo custom field

Supported operators

= , != , > , >= , < , <=
IS , IS NOT , IN , NOT IN

Unsupported operators

~ , !~ 
WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED

Supported functions

When used with the EQUALSNOT EQUALS, GREATER THAN, GREATER THAN EQUALS,
LESS THAN or LESS THAN EQUALS operators, this field supports:

  • currentLogin()

  • lastLogin()

  • now()

  • startOfDay()

  • startOfWeek()

  • startOfMonth()

  • startOfYear()

  • endOfDay()

  • endOfWeek()

  • endOfMonth()

  • endOfYear()

Examples

  • Find todoItems that have date before 12th December 2020:
    "ToDo List" < "2020/12/12"

  • Find todoItems that have date after 2.00pm on 31st December 2020:
    "ToDo List" > "2020/12/31 14:00"

  • Find todoItems that have date more than two weeks ago:
    "ToDo List" < "-2w"

  • Find todoItems that have date on 15 January 2019:
    "ToDo List" > "2019/01/15" and updated < "2019/01/16"