| Resource | Comments and query string arguments |
|---|
| GET /rest/reqs/1/requirement2/{spaceKey} | Search for requirements. - q = The query, using the Search Syntax.
- spaceKey = The scope of the search. This is different from the spaceKey in the GET path. If the spaceKey in the query string isn't provided, and if the "Isolate Spaces" option is ticked in the Requirement Yogi administration, then the search will be restricted by default to the spaceKey provided in the GET path; Otherwise the spaceKey provided in the GET path has no effect.
- offset = The pagination offset
- limit = The pagination limit
- order = The SQL ORDER BY clause (by default: "REQKEY ASC, BASELINE DESC")
- includeArchived = true / false whether the archived requirements should be included. Otherwise, only current (ACTIVE) requirements are displayed.
- baselineCondition = Do not use.
- suggest = Do not use.
|
| POST /rest/reqs/1/requirement2/{spaceKey} | Do not use. |
| PUT /rest/reqs/1/requirement2/{spaceKey} | Do not use. |
| GET /rest/reqs/1/requirement2/{spaceKey}/{key} | Get a requirement. - v = {integer} – Return the version of the requirement in baseline 'v'
- expand = Use "references" if references to pages need to be expanded.
|
| POST /rest/reqs/1/requirement2/{spaceKey}/{key} | Do not use. |
| PUT /rest/reqs/1/requirement2/{spaceKey}/{key} | Do not use. |
| DELETE /rest/reqs/1/requirement2/{spaceKey}/{key} | Do not use. |
| GET /rest/reqs/1/baseline/{spaceKey} | Get the list of baselines in this space. - expand: Use "details" if you need to get the link to the baseline page and the number of requirements.
|