NOW LOADING

REST API

REST APIs for Requirement Yogi - Jira Integration

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

APIResource

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

GET /rest/reqs/1/api
POST /rest/reqs/1/api
PUT /rest/reqs/1/api/{applinkId}/mode
PUT /rest/reqs/1/api/{applinkId}/version

IssueLinkResource

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

PUT /rest/reqs/1/issuelinks/{issueKey}
DELETE /rest/reqs/1/issuelinks/{issueKey}

JiraBackupResource

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


JiraCommonQueueResource

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


JiraMiscResource

The search resource for requirements

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

DELETE /rest/reqs/1/baselines/{project}
GET /rest/reqs/1/baselines/{projectKey}
PUT /rest/reqs/1/preferences/baselineCondition
PUT /rest/reqs/1/rename
GET /rest/reqs/1/history/issue/{issueNumber}
GET /rest/reqs/1/relationships

MetadataResource

A resource to retrieve the metadata for Requirement Yogi, such as the list of custom fields

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

GET /rest/reqs/1/metadata/customfields

OperationsResource

In this class, we'll progressively move all operations, such as /rename and /createRIL.

@since 2.2 and the implementation of RY-395 (the big Jira refactor)

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

GET /rest/reqs/1/operations/{applinkId}
PUT /rest/reqs/1/operations/{applinkId}/rename
POST /rest/reqs/1/operations/{applinkId}/issues-bulk-operation/projects/{projectId}
GET /rest/reqs/1/operations/{applinkId}/issues-bulk-operation/jobs
GET /rest/reqs/1/operations/{applinkId}/issues-bulk-operation/jobs/{jobId}
POST /rest/reqs/1/operations/{applinkId}/issues-bulk-operation/jobs/{jobId}/abort
DELETE /rest/reqs/1/operations/{applinkId}/issues-bulk-operation/jobs/{jobId}

QueueResource

This resource used to contain the queue, but it was transferred to the CommonQueueResource,
at /rest/reqs/1/common-queue/queue

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

POST /rest/reqs/1/queue/{applinkId}/repair-applink

RecoverNullKeysResource

The search resource for requirements

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

GET /rest/reqs/1/recover-null-keys/suggest
GET /rest/reqs/1/recover-null-keys/requirement
PUT /rest/reqs/1/recover-null-keys/associate/{id}

SearchResource

A resource to search for requirements in Confluence.

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


SettingsResource

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

POST /rest/reqs/1/settings/{serviceId}/set-remote-user

SyncResource

Resource to manage the job that resynchronizes a set of issues with Confluence.

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

GET /rest/reqs/1/sync/create-random-data
GET /rest/reqs/1/sync/create-random-issues
GET /rest/reqs/1/sync
PUT /rest/reqs/1/sync
GET /rest/reqs/1/sync/job/{jobId}
POST /rest/reqs/1/sync/updatebaseline2