...
Install and use Atlassian's REST API Browser and explore URLs inside of your Confluence / Jira application:
Tip | ||
---|---|---|
| ||
See:
|
REST Resources in Confluence
Verb and URL | Comments and query string arguments | |||||||
---|---|---|---|---|---|---|---|---|
GET /rest/reqs/1/requirement2/{spaceKey} | Search for requirements.
| |||||||
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.
| |||||||
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/requirement3 | Do not use. | |||||||
Baselines | ||||||||
GET /rest/reqs/1/baseline/{spaceKey} | Get the list of baselines in this space.
| |||||||
POST /rest/reqs/1/baseline/{spaceKey}/1/create | Freeze a baseline. The body must be in JSON:
The ceo is the baseline page. It is not the page which contains the original definition of the requirements. It can be any arbitrary page, its title will be synchronized with the name of the baseline, and if there is a Baseline macro on it, this macro will show the count of requirements. The queryString is the list of all requirements which must be copied and archived in this baseline. | |||||||
POST /rest/reqs/1/baseline/{spaceKey}/1/create-instant | Create and freeze instantly a baseline. There will be no parent page for this baseline. The body must be JSON:
If fromCeoWithChildren is true, the requirements of all the child pages will be baselined too. | |||||||
DELETE /rest/reqs/1/baseline/{spaceKey}/{baseline} | Delete a baseline. No JSON body. | |||||||
PUT /rest/reqs/1/baseline/{spaceKey}/{baseline}/label | Change the label of a baseline. Use a text/plain body. | |||||||
GET /rest/reqs/1/baseline/{spaceKey}/{baseline}/pages | Returns the list of pages which have requirements of this baseline. | |||||||
POST /rest/reqs/1/sync | Deprecated. Do not use. | |||||||
POST /rest/reqs/1/helpers/reindex/{contentId} | Reindexes a page. It will only mark the requirements are ACTIVE/DELETED and flag them as "Needs excerpt", which means those requirements will appear with a red dot. The next time a user views the page, excerpts will be gathered and saved as the text and properties of requirements, and the red dot will disappear. | |||||||
GET /rest/reqs/1/integration | Returns the list of application links and their RY configuration. Permissions: Confluence administrators only.
| |||||||
POST /rest/reqs/1/integration | Create an integration. Don't do it. Permissions: Confluence administrators only. | |||||||
GET /rest/reqs/1/integration/{serviceId} | Returns the details of the integration:
Permissions: Confluence administrators only. | |||||||
PUT /rest/reqs/1/integration/{serviceId} | Updates the descriptor. Permissions: Confluence administrators only. | |||||||
GET /rest/reqs/1/integration/{serviceId}/queue/outbound?limit=50 | Get the list of messages which will be sent to Jira in the next synchronization (every 3 mintues):
| |||||||
PUT /rest/reqs/1/integration/{serviceId}/queue/outbound/{messageId} | PUT sends this item to Jira. No body necessary. DELETE removes this message from the list. |
...