Child pages
  • Using JQL to Select Issues in Structure

This documentation relates to an older version 2.2 of the Structure Plugin for JIRA. View the current documentation home.

Skip to end of metadata
Go to start of metadata

Structure adds structure() JQL function that lets you search for issues that are added to a structure, or for all sub-issues of a certain issue in a structure.

In order to search for structure issues, you need to use Advanced Searching in JIRA and JQL.

structure() JQL function

To specify a structure condition in JQL, use the following format:

issue in structure(structureNameopt, parentIssueopt)

Function arguments:

structureName

Optional

The name of the structure. If you omit the structure name, the default Global Structure will be searched – unless it was removed from JIRA. Remember to enclose the name in double quotes ("") if it contains spaces or non-letters.

parentIssue

Optional

Use this parameter to select only part of the structure that consists of the specified parent issues and all its sub-issues of any level. If the issue specified is not added to the structure, an empty set is returned.

You can use structure ID instead of the structure name. You can see structure ID in the URL of the Structure Board if you open Manage Structure page and click on the structure.

Examples

  • issue in structure() — issues that are added to the Global Structure
  • issue in structure("My Personal Structure") — issues that are added to structure called "My Personal Structure"
  • issue in structure(101) — issues that are added to structure with ID 101
  • issue in structure(PROJECT-123) — issues that are added to the Global Structure, and are located under PROJECT-123 issue at some level, including the PROJECT-123 issue itself.
  • issue in structure("Structure X", PROJECT-123) — issues that are added to the structure named "Structure X", and are located under PROJECT-123 issue at some level, including the PROJECT-123 issue itself.

If a user does not have access to structure, they will not be able to create new queries with the structure() function and existing queries will have structure() function return an empty set. However, the user will still see structure() function offered in the JQL completion drop-down.