ZQL Reference
ZQL is a simple structured query language that allows you to string together the right fields to search on with values, using the appropriate operators and keywords. The search box allows auto-completion making it really easy to construct a query. With the cursor in the search box, select the spacebar on your keyboard to be shown a list of fields, operators, keywords and values.
For example, if you are looking for all the failed tests in the Ironclad project, you would enter a query that looked like this:
project = "Project Ironclad" and status = "Fail"
Here, project and status are fields, and Project Ironclad and Fail are the values, joined together by the keyword and with the operator =.
Testcases |
|
|
|
Field | Data Type | Operator |
|
altid | string | , ! |
|
automated | boolean | =, != |
|
comment | string | , ! |
|
contents | string | , ! |
|
creator | string | =, !=, in |
|
creatorid | long | =, !=, in | API only |
id | long | =, !=, in |
|
name | string | , ! |
|
priority | string | =, !=, in |
|
project | string | =, !=, in |
|
release | string | =, !=, in |
|
releaseid | long | =, !=, in | API only |
revision | int | =, !=, in | API only |
tag | string | =, !=, in |
|
treeid | long | =, !=, in | API only |
Executions |
|
|
|
Field | Data Type | Operator |
|
altid | string | , ! |
|
assignee | string | =, !=, in |
|
assigneeid | long | =, !=, in | API only |
automated | boolean | =, != |
|
comment | string | , ! |
|
contents | string | , ! |
|
creator | string | =, !=, in |
|
creatorid | long | =, !=, in | API only |
cyclephase | string | =, !=, in |
|
cyclephaseid | long | =, !=, in | API only |
executor | string | =, !=, in |
|
executorid | long | =, !=, in | API only |
id | long | =, !=, in |
|
name | string | , ! |
|
notes | string | , ! |
|
priority | string | =, !=, in |
|
project | string | =, !=, in |
|
release | string | =, !=, in |
|
releaseid | long | =, !=, in | API only |
revision | int | =, !=, in | API only |
scheduleid | long | =, !=, in | API only |
status | string | =, !=, in |
|
tag | string | =, !=, in |
|
treeid | long | =, !=, in | API only |
Requirements | |||
Field | Data Type | Operator |
|
altid | string | , ! |
|
creator | string | =, !=, in |
|
creatorid | long | =, !=, in | API only |
details | string | , ! |
|
id | long | =, !=, in |
|
name | string | , ! |
|
priority | string | =, !=, in |
|
project | string | =, !=, in |
|
release | string | =, !=, in |
|
requirementtreeid | long | =, !=, in | API only |
url | string | , ! |
|
LIST OF KEYWORDS
and
not
or
Starting Release 8.2, Zephyr Enterprise documentation is moving from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise Documentation page. https://support.smartbear.com/zephyr-enterprise/docs/en/welcome-to-zephyr-enterprise.html