Requirement Yogi provides a search screen in every space.
By default, only active requirements of the current space are displayed. Use the URL to display deleted requirements or to search across spaces.
Syntax
| Query | Result | Version |
|---|---|---|
| key = "IG-1" | The requirement with the exact key. | 1.1 |
| key ~ "IG-%" | All requirements starting with "IG-". | 1.3 |
| text ~ "% something" | All requirements whose text ends with "something". | 1.3 |
| page = "467382" | All requirements defined on the page with ID 467382. | 1.3 |
| page ~ "467382" | All requirements defined or linked on the page. | 1.3 |
| jira = "JRA-21" | All requirements linked from the issue JRA-21. | 1.3 |
| NOT (JIRA ~ "%") | Requirements which are not linked to any JIRA issue. | 1.3 |
| @Category = "Functional" | All requirements where the property "Category" = "Functional". | 1.3 |
Keywords
| Keyword | Function |
|---|---|
| AND, OR, NOT | Boolean operators |
| = "..." | Strict equality. |
| ~ "...%..." | Soft equality. Use % in the string as a wildcard. |
| @... | Reference to a property of the requirement. |
Fields
| Field | Definition | Version |
|---|---|---|
| key | The key of the requirement. Keys are unique per space. | 1.1 |
| spaceKey | The space key of the requirement (case sensitive). | 1.1 |
| status | The status of the requirement (ACTIVE, DELETED, MOVED). | 1.1 |
| text | The contents of the requirement (Does not include the properties). | 1.1 |
| page | The ID of a page linked to the requirement. | 1.3 |
| jira | A JIRA issue linked to the requirement. | 1.3 |