...
| Info |
|---|
|
This API is not stable. It is subject to changes with every RY version. |
Base URL
...
Our API is subject to changes. - When we annotate @Public, we attempt with "best effort" to keep the API backwards-compatible for as long as possible.
- If we want to deprecate, we will annotate with @Deprecated for a few versions, then remove it in the major version (in "platform.major.micro" versioning scheme, for example in 2.2.0).
- We may add parameters, not remove them.
- When we annotate @Internal, we don't even try to keep it stable, it usually changes from 1 micro version to another. Those APIs are tightly couples with the Javascript.
- When we don't annotate, please consider it as @Internal.
|
How to build the URL?
The "base URL" is the address of Confluence. It could be:
https://confluence.example.com if there is no port, no context path and it's https.http://confluence.example.com:8090/confluence if there is a port, a context path and http.
How to check?
...
Try with {baseUrl}/admin/viewgeneralconfig.action
...
to ensure you have the right one. In the following documentation, we will omit the base URL.
Good tip
Install and use Atlassian's REST API Browser and explore URLs inside of your Confluence / Jira application:
Image Added
REST Resources
| Resource Verb and URL | 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.
|
...