NOW LOADING

REST API

REST APIs for Requirement Yogi (Confluence)

This documentation is also available inside the product using Atlassian's REST API Browser.

BaselineResource

Details of the baselines.
See the accompanying REST resource for helpful methods: /baseline-actions

@PublicApi This API is public. See our policy.

GET /rest/reqs/1/baseline
GET /rest/reqs/1/baseline/{spaceKey}
GET /rest/reqs/1/baseline/{spaceKey}/{version}
GET /rest/reqs/1/baseline/{spaceKey}/{version}/pages
POST /rest/reqs/1/baseline/{spaceKey}
PUT /rest/reqs/1/baseline/{spaceKey}/{version}
PUT /rest/reqs/1/baseline/{spaceKey}/{version}/label
DELETE /rest/reqs/1/baseline/{spaceKey}/{version}

RequirementResource2

CRUD API for requirements. As opposed to RequirementResource, this one is space-local.

@PublicApi This API is public. See our policy.

GET /rest/reqs/1/requirement2/{spaceKey}/{key}
GET /rest/reqs/1/requirement2/{spaceKey}
POST /rest/reqs/1/requirement2/{spaceKey}/{key}
DELETE /rest/reqs/1/requirement2/{spaceKey}/{key}
PUT /rest/reqs/1/requirement2/{spaceKey}/{key}
PUT /rest/reqs/1/requirement2/{spaceKey}

RequirementResource3

A Requirement resource that returns requirements in bulk

@since 2.2.5 / APIv5

@PublicApi This API is public. See our policy.

PUT /rest/reqs/1/requirement3/request

AccumulatorResource

@Internal Private resource. It will change often and it is not entirely documented.

PUT /rest/reqs/1/accumulator/{spaceKey}

BaselineActionsResource

Actions on baselines

@since 3.0.10

@Internal Private resource. It will change often and it is not entirely documented.

POST /rest/reqs/1/baseline-actions/{spaceKey}/freeze/{version}
GET /rest/reqs/1/baseline-actions/{spaceKey}/search
GET /rest/reqs/1/baseline-actions/{spaceKey}/suggest
POST /rest/reqs/1/baseline-actions/{spaceKey}/pre-refreeze-summary

ConfluenceCommonQueueResource

@Internal Private resource. It will change often and it is not entirely documented.

GET /rest/reqs/1/common-queue

ExcelResource

REST endpoint to handle files for excel Integration

@Internal Private resource. It will change often and it is not entirely documented.

GET /rest/reqs/1/excel/{spaceKey}/{attachmentId}/config
POST /rest/reqs/1/excel/{spaceKey}/{attachmentId}/config/integrationState
DELETE /rest/reqs/1/excel/{spaceKey}/{attachmentId}

ExternalPropertyResource

/external-properties/MAIN?q=XXX
/external-properties/MAIN/REQ-001

CRUD API for External Properties.

@Internal Private resource. It will change often and it is not entirely documented.

GET /rest/reqs/1/external-properties/{spaceKey}/count
PUT /rest/reqs/1/external-properties/{spaceKey}
PUT /rest/reqs/1/external-properties/{spaceKey}/{key}

HelpersResource

Various functions that didn't fit in other resources

@Internal Private resource. It will change often and it is not entirely documented.

PUT /rest/reqs/1/helpers/reindex/{contentId}

IntegrationResource

A REST resource to integrate RY with any other software.

@Internal Private resource. It will change often and it is not entirely documented.

GET /rest/reqs/1/integration
POST /rest/reqs/1/integration
GET /rest/reqs/1/integration/{serviceId}
POST /rest/reqs/1/integration/{serviceId}/check-applinks
POST /rest/reqs/1/integration/{serviceId}/authenticate-user
POST /rest/reqs/1/integration/{serviceId}/change-version
PUT /rest/reqs/1/integration/{serviceId}
DELETE /rest/reqs/1/integration/{serviceId}
GET /rest/reqs/1/integration/{serviceId}/queue/inbound
POST /rest/reqs/1/integration/{serviceId}/queue/inbound
GET /rest/reqs/1/integration/{serviceId}/applink/test

IssueTemplatesResource

@Internal Private resource. It will change often and it is not entirely documented.

GET /rest/reqs/1/templates/{spaceKey}/
POST /rest/reqs/1/templates/{spaceKey}/
PUT /rest/reqs/1/templates/{spaceKey}/{id}
DELETE /rest/reqs/1/templates/{spaceKey}/{id}
GET /rest/reqs/1/templates/{spaceKey}/{id}/issues

JiraResources

Resources for our Jira Bulk Issue Creation.
Only for internal usage. Quite useless for API users, you would be better off directly using Jira's DC REST APIs:
https://docs.atlassian.com/software/jira/docs/api/REST/8.11.0/

@Internal Private resource. It will change often and it is not entirely documented.

GET /rest/reqs/1/integration/{serviceId}/jira/projects
GET /rest/reqs/1/integration/{serviceId}/jira/projects/{projectKey}/meta
GET /rest/reqs/1/integration/{serviceId}/jira/projects/{projectKey}/meta/{issueTypeId}
GET /rest/reqs/1/integration/{serviceId}/jira/projects/{projectKey}/relationships
POST /rest/reqs/1/integration/{serviceId}/jira/create-issues-bulk
GET /rest/reqs/1/integration/{serviceId}/jira/issues

KeySuggestionResource

A service for the suggestion of requirement keys.

@Internal Private resource. It will change often and it is not entirely documented.

POST /rest/reqs/1/key-suggestions/{spaceKey}/suggestAtInitialization
DELETE /rest/reqs/1/key-suggestions/{spaceKey}/

LongRunningTaskResource

@Internal Private resource. It will change often and it is not entirely documented.

GET /rest/reqs/1/tasks/status/{taskId}
GET /rest/reqs/1/tasks/jobs
GET /rest/reqs/1/tasks/jobs/{jobId}
POST /rest/reqs/1/tasks/jobs/{jobId}/abort
DELETE /rest/reqs/1/tasks/jobs/{jobId}
PUT /rest/reqs/1/tasks/status/{taskId}/pages/{id}
DELETE /rest/reqs/1/tasks/{taskId}

MiscResource

A resource for various needs that couldn't be addressed in other resources

@Internal Private resource. It will change often and it is not entirely documented.

GET /rest/reqs/1/misc/{spaceKey}/history
GET /rest/reqs/1/misc/{spaceKey}/uiSearch
PUT /rest/reqs/1/misc/{spaceKey}/uiSearch
GET /rest/reqs/1/misc/{spaceKey}/{pageId}
POST /rest/reqs/1/misc/{spaceKey}/migrateUsersQueries
PUT /rest/reqs/1/misc/{spaceKey}/uiTraceability
GET /rest/reqs/1/misc/{spaceKey}/traceability/data
GET /rest/reqs/1/misc/{spaceKey}/traceability/data/{id}
GET /rest/reqs/1/misc/{spaceKey}/dependency
GET /rest/reqs/1/misc/{spaceKey}/extended-mode

OnboardingResource

CRUD API to remember what the user has already onboarded. It's like settings, but attached to a user's profile.

@Internal Private resource. It will change often and it is not entirely documented.

PUT /rest/reqs/1/onboarding/{settingsName}
POST /rest/reqs/1/onboarding/notifications

PropertyNameResource

CRUD API for PropertyName management

@Internal Private resource. It will change often and it is not entirely documented.

GET /rest/reqs/1/propertynames/{spaceKey}
POST /rest/reqs/1/propertynames/{spaceKey}
PUT /rest/reqs/1/propertynames/{spaceKey}/{propertyName}
DELETE /rest/reqs/1/propertynames/{propertyName}

RYSettingsResource

CRUD API for settings.

@Internal Private resource. It will change often and it is not entirely documented.

GET /rest/reqs/1/settings
GET /rest/reqs/1/settings/{settingsName}
PUT /rest/reqs/1/settings/{settingsName}
PUT /rest/reqs/1/settings

RepairResource

A resource for repairs, when there is a data discrepancy between Confluence and Jira and an admin has to
manually fix it.

@Internal Private resource. It will change often and it is not entirely documented.

GET /rest/reqs/1/repair/jiralinks
DELETE /rest/reqs/1/repair/jiralinks
PUT /rest/reqs/1/repair/jiralinks

RteResource

A resource for anything managed in the Rich Text Editor

@Internal Private resource. It will change often and it is not entirely documented.

GET /rest/reqs/1/rte/{spaceKey}/suggest2
GET /rest/reqs/1/rte/{spaceKey}/report/transform-to-html
GET /rest/reqs/1/rte/{spaceKey}/traceability/transform-to-html

TraceabilityResource

Access to traceability matrix.TraceabilityMatrixfor the detail of a traceability matrix

@Internal Private resource. It will change often and it is not entirely documented.

GET /rest/reqs/1/traceability/{spaceKey}/
GET /rest/reqs/1/traceability/{spaceKey}/{id}
POST /rest/reqs/1/traceability/{spaceKey}
PUT /rest/reqs/1/traceability/{spaceKey}/{id}
DELETE /rest/reqs/1/traceability/{spaceKey}/{id}
PUT /rest/reqs/1/traceability/{spaceKey}/uiTraceability
PUT /rest/reqs/1/traceability/{spaceKey}/uiTraceability/column/{columnNumber}/frontEndData
GET /rest/reqs/1/traceability/{spaceKey}/uiTraceability/customfields/{applink}

TypesResource

@Internal Private resource. It will change often and it is not entirely documented.

GET /rest/reqs/1/types/{spaceKey}
POST /rest/reqs/1/types/{spaceKey}/createAndReplace
POST /rest/reqs/1/types/{spaceKey}/create

UninstallResource

Rest resource for macros uninstallation.

@Internal Private resource. It will change often and it is not entirely documented.

DELETE /rest/reqs/1/uninstall/pages/{pageId}