PostgreSQL preferred
Criteria such as "jira", "page" or "properties" are only available for users of PostgreSQL. We're very sorry for the inconvenience, we're limited by the platform in this situation.
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
Note: All those examples require Requirement Yogi 1.3.
| Query | Result |
|---|---|
| key = 'IG-1' | The requirement with the exact key. |
| key ~ 'IG-%' | All requirements starting with 'IG-'. |
| text ~ '% something' | All requirements whose text ends with 'something'. |
| page = '467382' | All requirements defined on the page with ID 467382. (PostgreSQL only) |
| page ~ '467382' | All requirements defined or linked on the page. (PostgreSQL only) |
| jira = 'JRA-21' | All requirements linked from the issue JRA-21. (PostgreSQL only) |
| NOT (JIRA ~ '%') | Requirements which are not linked to any JIRA issue. (PostgreSQL only) |
| @Category = 'Functional' | All requirements where the property 'Category' = 'Functional'. (PostgreSQL only) |
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. (PostgreSQL only) |
Fields
| Field | Definition |
|---|---|
| key | The key of the requirement. Keys are unique per space. |
| spaceKey | The space key of the requirement (case sensitive). |
| status | The status of the requirement (ACTIVE, DELETED, MOVED). |
| text | The contents of the requirement (Does not include the properties). |
| page | The ID of a page linked to the requirement. (PostgreSQL only) |
| jira | A JIRA issue linked to the requirement. (PostgreSQL only) |