REST API

BaselineResource

@PublicApi This API is public. See our policy.

GET /rest/reqs/1/baseline/{spaceKey}

@PublicApi This API is public. See our policy.

@PublicAPI – Read our API policy

List the baselines in this space.

Type	Name	Description
Path param	{spaceKey}	String. the space key
Query param	?expand=...	String. Use "details" if you need to URL to the baseline or the count of requirements.
Returns		HTTP Response. a list of Baselines.

GET /rest/reqs/1/baseline/{spaceKey}/{version}/pages

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

List the baselines in this space.

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{version}	int.
Returns		HTTP Response. a list of pages.

POST /rest/reqs/1/baseline/{spaceKey}/1/create

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

Freeze a baseline, based on a query.

API subject to change in micro releases.

Type Name Description

Path param {spaceKey} String. the space key

Body

JSON containing:

queryString: The RY search query of all the requirements to freeze. The query is local to the space.
ceo: Optional. The pageId of the baseline's summary page. If present, renaming the page will rename the baseline. A "Baseline" macro on that page displays the count of requirements. A "RY Report" macro on that page with $currentBaseline in the search query will display the list of requirements in this baseline.
name: The name of the baseline. Non null. Should be the same as the title of the summary page, because if the summary page has its title changed, the title of this baseline will be updated

{ // Object of type CreationPayloadClassic
 queryString: String,
 name: String,
 ceo: String,
}

Returns HTTP Response. the details of the baseline, in JSON.

POST /rest/reqs/1/baseline/{spaceKey}/2/create-instant

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

Freeze a baseline, based on a query.

API subject to change in micro releases.

Type Name Description

Path param {spaceKey} String. the space key

Body

JSON containing:

queryString: The RY search query of all the requirements to freeze. The query is local to the space.
ceo: Optional. The pageId of the baseline's summary page.
name: The name of the baseline. Non null. Should be the same as the title of the summary page, because if the summary page has its title changed, the title of this baseline will be updated

{ // Object of type CreationPayloadInstant
 name: String,
 fromCeo: Long,
 fromCeoWithChildren: boolean,
}

Returns HTTP Response. the details of the baseline, in JSON.

PUT /rest/reqs/1/baseline/{spaceKey}/{version}/label

@PublicApi This API is public. See our policy.

Not documented

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{version}	int.
Body		String.
Returns		HTTP Response.

DELETE /rest/reqs/1/baseline/{spaceKey}/{version}

@PublicApi This API is public. See our policy.

Not documented

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{version}	int.
Returns		HTTP Response.

GET /rest/reqs/1/baseline/{spaceKey}/0/search

@PublicApi This API is public. See our policy.

Verifies the validity of the name for the next baseline

Type	Name	Description
Path param	{spaceKey}	String.
Query param	?baselineName=...	String.
Returns		HTTP Response.

GET /rest/reqs/1/baseline/{spaceKey}/0/suggest

@PublicApi This API is public. See our policy.

Suggest the name for the next baseline

Type	Name	Description
Path param	{spaceKey}	String.
Query param	?pageName=...	String.
Returns		HTTP Response.

PUT /rest/reqs/1/baseline/{spaceKey}/0/refreeze

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

Used to refreeze a baseline and create a new page for it. It executes a longRunningTask that will do this operation.
Returns task information in order to render it in the client side and a taskId which will be used to check the progression of the task.BaselineRefreezeLongRunningTask

Type	Name	Description
Path param	{spaceKey}	String.
Body		`{ // Object of type RefreezePayload baselineNumberToRefreeze: int, requirements: [ { // Object of type RequirementRef relationship: String, // The user's name on the relationship spaceKey: String, // The requirement's space key: String, // The requirement key baseline: Integer, // The requirement baseline url: String, }, ... ], title: String, }`
Returns		HTTP Response.

RequirementResource2

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

@PublicApi This API is public. See our policy.

PUT /rest/reqs/1/requirement2/{spaceKey}/{key}/link/issue/{issue}

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

@InternalAPI – Not intended for use by customers

Adds or removes a link between a requirement and a Jira issue.

@deprecated since 2.2 and RY-395, we've replaced with posting to /queue/inbound

Type	Name	Description
Path param	{key}	String. the requirement key
Path param	{spaceKey}	String. the space key
Path param	{issue}	String. the Jira issue key
Query param	?baseline=...	Integer.
Query param	?jiraUrl=...	String. the Jira url. Only the Applink ID is saved in the requirement link.
Query param	?relationship=...	String.
Body		the title of the issue. `{ // Object of type RequirementResource2.IssueLinkDetails title: String, relationship: String, }`
Returns		HTTP Response. 201-CREATED

DELETE /rest/reqs/1/requirement2/{spaceKey}/{key}/link/issue/{issue}

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

@InternalAPI – Not intended for use by customers

Adds or removes a link between a requirement and a Jira issue.

@deprecated since 2.2 and RY-395, we've replaced with posting to /queue/inbound

Type	Name	Description
Path param	{key}	String. the requirement key
Path param	{spaceKey}	String. the space key
Path param	{issue}	String. the Jira issue key
Query param	?baseline=...	Integer.
Query param	?relationship=...	String.
Query param	?jiraUrl=...	String. the Jira url. Only the Applink ID is saved in the requirement link.
Returns		HTTP Response. 204-NO_CONTENT

GET /rest/reqs/1/requirement2/{spaceKey}/{key}

@PublicApi This API is public. See our policy.

@PublicAPI – Read our API policy

Get a requirement

Type	Name	Description
Path param	{key}	String. the key
Path param	{spaceKey}	String. the space key
Query param	?v=...	String. the baseline (optional)
Query param	?expand=...	String. Use "references" if references need to be expanded (optional)
Returns		HTTP Response.

GET /rest/reqs/1/requirement2/{spaceKey}

@PublicApi This API is public. See our policy.

@PublicAPI – Read our API policy

Search for requirements.

Type	Name	Description
Path param	{spaceKey}	String. The space key in the URL path. It is only used for information purpose. If the other spaceKey is missing, and if the option "Isolate Spaces" is ticked in the administration, then the search is restricted to this space. Can be "*".
Query param	?q=...	String. the search query, in the Search Syntax format (see Search Syntax).
Query param	?spaceKey=...	String. Comma-separated list, or "*" to ignore spaces. Restricts the search to this specific space. If null, and if the option "isolate spaces" is ticked, then it is defaulted to the current space.
Query param	?offset=...	Integer. Used for pagination
Query param	?includeArchived=...	boolean. Whether the archived requirements should be included. By default (false), only current (ACTIVE) requirements are displayed, unless there is a reason not to (such as a baselineCondition).
Query param	?baselineCondition=...	String. Restrict the search to these specific baselines. Example: "ds-1,ie-8" signifies "The baseline 1 of space 'ds' or the baseline 8 of space 'ie'".
Query param	?limit=...	Integer. Used for pagination
Query param	?sort=...	String. The SQL ORDER BY clause, by default "REQKEY ASC, BASELINE DESC"
Query param	?order=...	String. Do not use.
Query param	?suggest=...	Integer.
Returns		HTTP Response.

POST /rest/reqs/1/requirement2/{spaceKey}/{key}

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

@InternalAPI – Not intended for use by customers

Reserve one or several requirements for a given page or draft.
If mode = null,
- Reserve only one requirement, 'key'.
- If it already exists (with status ACTIVE), return 409-CONFLICT
- If it already exists (with status DELETED) and the config is ok with replacing, return 401-CREATED
- If it already exists (with status DELETED) and the config is not ok with replacing, return 400-BAD_REQUEST
If mode = 'suggest',
- Reserve requirements defined by suggestPrefix, suggestStart, suggestPadding, suggestQuantity.
- If some already exist, increment up to 10x the suggest quantity. If still fail, return 400-Bad request.
If mode = 'provided',
- Reserve requirements defined by the 'provided' parameter.
- If some already exist, return 400-Bad request with a detailed error message.
Example: To reserve 5 requirements from REQ-001, use:
POST /spaceKey/WHATEVER?mode=suggest&suggestPrefix=REQ-&suggestStart=1&suggestPadding=3&suggestQuantity=5
Example: To reserve 1 requirement, use:
POST /spaceKey/REQ-001
Example: To reserve 2 requirements, use:
POST /spaceKey/WHATEVER?mode=provided&provided=REQ-001,REQ-002

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{key}	String.
Query param	?mode=...	String.
Query param	?suggestPrefix=...	String.
Query param	?suggestStart=...	Integer.
Query param	?suggestPadding=...	Integer.
Query param	?suggestQuantity=...	Integer.
Query param	?provided=...	String. list of requirements to create. It was removed in 2.5.1. Before that, it was a comma-separated list of keys.
Query param	?providedJson=...	String. a JSON list of requirements to create. It was created in 2.5.1 to replace 'provided', since we now accept commas in requirement keys.
Query param	?override=...	boolean.
Query param	?pageId=...	Long.
Body		{ // Object of type Requirement id: int, key: String, spaceKey: String, baseline: Integer, // The baseline of the requirement. It's either the actual baseline, or the latest baseline number of the space. baselineDetails: { // Object of type Baseline baseline: Integer, spaceKey: String, name: String, pageId: Long, // Optional. The page where the release is described. count: Integer, // Optional. The number of requirements in this baseline. pageCount: Integer, // Optional. The number of pages frozen by this baseline. pageUrl: String, // Optional. The url of the page where the release is described, omitting the contextPath. indexUrl: String, // The url of the list-baselines.action page, omitting the contextPath. canonicalUrl: String, // The url of the page, or, by default, the indexUrl }, newSpaceKey: String, status: String, htmlExcerpt: String, htmlNeedsUpdating: boolean, page: { // Object of type PageRef pageId: Long, version: Long, // The version of the page. This is useful when a link points to an older version of a page. We don't use the ceoid of the older version, just the sequential number. occurrence: Integer, // The occurrence # on the page. Since 2.5.1, the default value is null for original links, and 1 for dependent links. It was modified like this // because some algo needed to know whether 'null' was because it was the first dependency, or null because it was an original. // However, the 'null' value didn't change in the DB. Before 2.5.1, the spec was that the first is null, and second is 2, 3, 4... There is no 0, no 1, // although they would display properly if there were some. dependencyId: Integer, // An integer, showing the ID of the REQ-to-REQ dependency covering this PageRef. }, // @deprecated Since 2.0.0, use 'origin' instead origin: { // Object of type Ref title: String, // The title of the document. Free text for the user. Generally contains the page or attachment name and its version, if any. Optional. Generally set after we've retrieved the reference. url: String, // The URL. Must contain the contextPath if it is relatived. Can also be absolute. We've changed in 2.3, we used to add the contextPath() when displaying this url, but the external integrations made us remove it, so we require a URL that can stand on its own. Optional. Generally set after we've retrieved the reference. type: String, // The type of reference. It is compared to hardcoded strings everywhere in js, because js doesn't have access to the class name. Known types: "excel" "jira" "imported" any Confluence CEO type ("draft", "page", "blog", etc.) "deleted" }, // The place where the requirement is defined. Can be an ExcelRef or a PageRef. duplicateOriginalPages: [ { // Object of type Ref title: String, // The title of the document. Free text for the user. Generally contains the page or attachment name and its version, if any. Optional. Generally set after we've retrieved the reference. url: String, // The URL. Must contain the contextPath if it is relatived. Can also be absolute. We've changed in 2.3, we used to add the contextPath() when displaying this url, but the external integrations made us remove it, so we require a URL that can stand on its own. Optional. Generally set after we've retrieved the reference. type: String, // The type of reference. It is compared to hardcoded strings everywhere in js, because js doesn't have access to the class name. Known types: "excel" "jira" "imported" any Confluence CEO type ("draft", "page", "blog", etc.) "deleted" }, ... ], references: [ { // Object of type PageRef pageId: Long, version: Long, // The version of the page. This is useful when a link points to an older version of a page. We don't use the ceoid of the older version, just the sequential number. occurrence: Integer, // The occurrence # on the page. Since 2.5.1, the default value is null for original links, and 1 for dependent links. It was modified like this // because some algo needed to know whether 'null' was because it was the first dependency, or null because it was an original. // However, the 'null' value didn't change in the DB. Before 2.5.1, the spec was that the first is null, and second is 2, 3, 4... There is no 0, no 1, // although they would display properly if there were some. dependencyId: Integer, // An integer, showing the ID of the REQ-to-REQ dependency covering this PageRef. }, ... ], tests: { // Object of type java.util.Map<java.lang.String,java.util.List<com.playsql.requirementyogi.api.beans.TestRef>> }, // Tests are always in anti-chronological order: The first is the most recent test. issues: [ { // Object of type JiraRef applink: String, issueKey: String, relationship: String, title: String, url: String, status: String, issueTemplateId: Integer, }, ... ], properties: [ { // Object of type Property type: { // Object of type Property.Type }, // All our properties are currently in AUTO mode key: String, // The key, in UTF-8 value: String, // Value, as HTML. Necessary for the property to be saved. searchUrl: String, // The search url (without the context path) if one wants to search by this property. Optional. display: boolean, indexation: { // Object of type PropertyIndexation text: String, // Internal. The indexation value, if it is a simple string. It must be null if 'multivalues' is used. multivalues: [ { // Object of type java.lang.String value: [ , ... ], coder: byte, hash: int, }, ... ], // Internal. Same as #text, but when it is a list. userMentions: [ { // Object of type java.lang.String value: [ , ... ], coder: byte, hash: int, }, ... ], // Internal. Same as #userMentions, but when it is a list. }, // Pre-parsed values to use for the search queries. Optional. This is only used when saving the excerpt of a requirement. This is not guaranteed to be present when reading a requirement from the DB. Please do not use outside the core of requirement yogi, the details may change without notice. If missing, then indexation will be performed by extracting the text out of the 'value' of the property. }, ... ], dependencies: [ { // Object of type RequirementRef relationship: String, // The user's name on the relationship spaceKey: String, // The requirement's space key: String, // The requirement key baseline: Integer, // The requirement baseline url: String, }, ... ], reverseDependencies: [ { // Object of type RequirementRef relationship: String, // The user's name on the relationship spaceKey: String, // The requirement's space key: String, // The requirement key baseline: Integer, // The requirement baseline url: String, }, ... ], genericUrl: String, destinationUrl: String, searchForVersionsUrl: String, // URL to search for different baselines of the requirement formattingCss: String, // A CSS attribute, converted from the Property "_formatting" using Property.convertToCss(). This value is not saved in the DB, use the properties to save anything formattingNoBorder: Boolean, // True if the "aui-label" border should be removed. False if not, null if unknown. Same as 'formattingCss': It is read-only for the UI; Use the properties to save anything. }
Returns		HTTP Response.

DELETE /rest/reqs/1/requirement2/{spaceKey}/{key}

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

@InternalAPI – Not intended for use by customers

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{key}	String.
Returns		HTTP Response.

PUT /rest/reqs/1/requirement2/{spaceKey}/{key}

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

@InternalAPI – Not intended for use by customers

This is the key place where we write the requirement description

Type	Name	Description
Path param	{key}	String.
Path param	{spaceKey}	String.
Body		{ // Object of type Requirement id: int, key: String, spaceKey: String, baseline: Integer, // The baseline of the requirement. It's either the actual baseline, or the latest baseline number of the space. baselineDetails: { // Object of type Baseline baseline: Integer, spaceKey: String, name: String, pageId: Long, // Optional. The page where the release is described. count: Integer, // Optional. The number of requirements in this baseline. pageCount: Integer, // Optional. The number of pages frozen by this baseline. pageUrl: String, // Optional. The url of the page where the release is described, omitting the contextPath. indexUrl: String, // The url of the list-baselines.action page, omitting the contextPath. canonicalUrl: String, // The url of the page, or, by default, the indexUrl }, newSpaceKey: String, status: String, htmlExcerpt: String, htmlNeedsUpdating: boolean, page: { // Object of type PageRef pageId: Long, version: Long, // The version of the page. This is useful when a link points to an older version of a page. We don't use the ceoid of the older version, just the sequential number. occurrence: Integer, // The occurrence # on the page. Since 2.5.1, the default value is null for original links, and 1 for dependent links. It was modified like this // because some algo needed to know whether 'null' was because it was the first dependency, or null because it was an original. // However, the 'null' value didn't change in the DB. Before 2.5.1, the spec was that the first is null, and second is 2, 3, 4... There is no 0, no 1, // although they would display properly if there were some. dependencyId: Integer, // An integer, showing the ID of the REQ-to-REQ dependency covering this PageRef. }, // @deprecated Since 2.0.0, use 'origin' instead origin: { // Object of type Ref title: String, // The title of the document. Free text for the user. Generally contains the page or attachment name and its version, if any. Optional. Generally set after we've retrieved the reference. url: String, // The URL. Must contain the contextPath if it is relatived. Can also be absolute. We've changed in 2.3, we used to add the contextPath() when displaying this url, but the external integrations made us remove it, so we require a URL that can stand on its own. Optional. Generally set after we've retrieved the reference. type: String, // The type of reference. It is compared to hardcoded strings everywhere in js, because js doesn't have access to the class name. Known types: "excel" "jira" "imported" any Confluence CEO type ("draft", "page", "blog", etc.) "deleted" }, // The place where the requirement is defined. Can be an ExcelRef or a PageRef. duplicateOriginalPages: [ { // Object of type Ref title: String, // The title of the document. Free text for the user. Generally contains the page or attachment name and its version, if any. Optional. Generally set after we've retrieved the reference. url: String, // The URL. Must contain the contextPath if it is relatived. Can also be absolute. We've changed in 2.3, we used to add the contextPath() when displaying this url, but the external integrations made us remove it, so we require a URL that can stand on its own. Optional. Generally set after we've retrieved the reference. type: String, // The type of reference. It is compared to hardcoded strings everywhere in js, because js doesn't have access to the class name. Known types: "excel" "jira" "imported" any Confluence CEO type ("draft", "page", "blog", etc.) "deleted" }, ... ], references: [ { // Object of type PageRef pageId: Long, version: Long, // The version of the page. This is useful when a link points to an older version of a page. We don't use the ceoid of the older version, just the sequential number. occurrence: Integer, // The occurrence # on the page. Since 2.5.1, the default value is null for original links, and 1 for dependent links. It was modified like this // because some algo needed to know whether 'null' was because it was the first dependency, or null because it was an original. // However, the 'null' value didn't change in the DB. Before 2.5.1, the spec was that the first is null, and second is 2, 3, 4... There is no 0, no 1, // although they would display properly if there were some. dependencyId: Integer, // An integer, showing the ID of the REQ-to-REQ dependency covering this PageRef. }, ... ], tests: { // Object of type java.util.Map<java.lang.String,java.util.List<com.playsql.requirementyogi.api.beans.TestRef>> }, // Tests are always in anti-chronological order: The first is the most recent test. issues: [ { // Object of type JiraRef applink: String, issueKey: String, relationship: String, title: String, url: String, status: String, issueTemplateId: Integer, }, ... ], properties: [ { // Object of type Property type: { // Object of type Property.Type }, // All our properties are currently in AUTO mode key: String, // The key, in UTF-8 value: String, // Value, as HTML. Necessary for the property to be saved. searchUrl: String, // The search url (without the context path) if one wants to search by this property. Optional. display: boolean, indexation: { // Object of type PropertyIndexation text: String, // Internal. The indexation value, if it is a simple string. It must be null if 'multivalues' is used. multivalues: [ { // Object of type java.lang.String value: [ , ... ], coder: byte, hash: int, }, ... ], // Internal. Same as #text, but when it is a list. userMentions: [ { // Object of type java.lang.String value: [ , ... ], coder: byte, hash: int, }, ... ], // Internal. Same as #userMentions, but when it is a list. }, // Pre-parsed values to use for the search queries. Optional. This is only used when saving the excerpt of a requirement. This is not guaranteed to be present when reading a requirement from the DB. Please do not use outside the core of requirement yogi, the details may change without notice. If missing, then indexation will be performed by extracting the text out of the 'value' of the property. }, ... ], dependencies: [ { // Object of type RequirementRef relationship: String, // The user's name on the relationship spaceKey: String, // The requirement's space key: String, // The requirement key baseline: Integer, // The requirement baseline url: String, }, ... ], reverseDependencies: [ { // Object of type RequirementRef relationship: String, // The user's name on the relationship spaceKey: String, // The requirement's space key: String, // The requirement key baseline: Integer, // The requirement baseline url: String, }, ... ], genericUrl: String, destinationUrl: String, searchForVersionsUrl: String, // URL to search for different baselines of the requirement formattingCss: String, // A CSS attribute, converted from the Property "_formatting" using Property.convertToCss(). This value is not saved in the DB, use the properties to save anything formattingNoBorder: Boolean, // True if the "aui-label" border should be removed. False if not, null if unknown. Same as 'formattingCss': It is read-only for the UI; Use the properties to save anything. }
Returns		HTTP Response.

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

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

@InternalAPI – Not intended for use by customers

Type	Name	Description
Path param	{spaceKey}	String.
Body		[ { // Object of type Requirement id: int, key: String, spaceKey: String, baseline: Integer, // The baseline of the requirement. It's either the actual baseline, or the latest baseline number of the space. baselineDetails: { // Object of type Baseline baseline: Integer, spaceKey: String, name: String, pageId: Long, // Optional. The page where the release is described. count: Integer, // Optional. The number of requirements in this baseline. pageCount: Integer, // Optional. The number of pages frozen by this baseline. pageUrl: String, // Optional. The url of the page where the release is described, omitting the contextPath. indexUrl: String, // The url of the list-baselines.action page, omitting the contextPath. canonicalUrl: String, // The url of the page, or, by default, the indexUrl }, newSpaceKey: String, status: String, htmlExcerpt: String, htmlNeedsUpdating: boolean, page: { // Object of type PageRef pageId: Long, version: Long, // The version of the page. This is useful when a link points to an older version of a page. We don't use the ceoid of the older version, just the sequential number. occurrence: Integer, // The occurrence # on the page. Since 2.5.1, the default value is null for original links, and 1 for dependent links. It was modified like this // because some algo needed to know whether 'null' was because it was the first dependency, or null because it was an original. // However, the 'null' value didn't change in the DB. Before 2.5.1, the spec was that the first is null, and second is 2, 3, 4... There is no 0, no 1, // although they would display properly if there were some. dependencyId: Integer, // An integer, showing the ID of the REQ-to-REQ dependency covering this PageRef. }, // @deprecated Since 2.0.0, use 'origin' instead origin: { // Object of type Ref title: String, // The title of the document. Free text for the user. Generally contains the page or attachment name and its version, if any. Optional. Generally set after we've retrieved the reference. url: String, // The URL. Must contain the contextPath if it is relatived. Can also be absolute. We've changed in 2.3, we used to add the contextPath() when displaying this url, but the external integrations made us remove it, so we require a URL that can stand on its own. Optional. Generally set after we've retrieved the reference. type: String, // The type of reference. It is compared to hardcoded strings everywhere in js, because js doesn't have access to the class name. Known types: "excel" "jira" "imported" any Confluence CEO type ("draft", "page", "blog", etc.) "deleted" }, // The place where the requirement is defined. Can be an ExcelRef or a PageRef. duplicateOriginalPages: [ { // Object of type Ref title: String, // The title of the document. Free text for the user. Generally contains the page or attachment name and its version, if any. Optional. Generally set after we've retrieved the reference. url: String, // The URL. Must contain the contextPath if it is relatived. Can also be absolute. We've changed in 2.3, we used to add the contextPath() when displaying this url, but the external integrations made us remove it, so we require a URL that can stand on its own. Optional. Generally set after we've retrieved the reference. type: String, // The type of reference. It is compared to hardcoded strings everywhere in js, because js doesn't have access to the class name. Known types: "excel" "jira" "imported" any Confluence CEO type ("draft", "page", "blog", etc.) "deleted" }, ... ], references: [ { // Object of type PageRef pageId: Long, version: Long, // The version of the page. This is useful when a link points to an older version of a page. We don't use the ceoid of the older version, just the sequential number. occurrence: Integer, // The occurrence # on the page. Since 2.5.1, the default value is null for original links, and 1 for dependent links. It was modified like this // because some algo needed to know whether 'null' was because it was the first dependency, or null because it was an original. // However, the 'null' value didn't change in the DB. Before 2.5.1, the spec was that the first is null, and second is 2, 3, 4... There is no 0, no 1, // although they would display properly if there were some. dependencyId: Integer, // An integer, showing the ID of the REQ-to-REQ dependency covering this PageRef. }, ... ], tests: { // Object of type java.util.Map<java.lang.String,java.util.List<com.playsql.requirementyogi.api.beans.TestRef>> }, // Tests are always in anti-chronological order: The first is the most recent test. issues: [ { // Object of type JiraRef applink: String, issueKey: String, relationship: String, title: String, url: String, status: String, issueTemplateId: Integer, }, ... ], properties: [ { // Object of type Property type: { // Object of type Property.Type }, // All our properties are currently in AUTO mode key: String, // The key, in UTF-8 value: String, // Value, as HTML. Necessary for the property to be saved. searchUrl: String, // The search url (without the context path) if one wants to search by this property. Optional. display: boolean, indexation: { // Object of type PropertyIndexation text: String, // Internal. The indexation value, if it is a simple string. It must be null if 'multivalues' is used. multivalues: [ { // Object of type java.lang.String value: [ , ... ], coder: byte, hash: int, }, ... ], // Internal. Same as #text, but when it is a list. userMentions: [ { // Object of type java.lang.String value: [ , ... ], coder: byte, hash: int, }, ... ], // Internal. Same as #userMentions, but when it is a list. }, // Pre-parsed values to use for the search queries. Optional. This is only used when saving the excerpt of a requirement. This is not guaranteed to be present when reading a requirement from the DB. Please do not use outside the core of requirement yogi, the details may change without notice. If missing, then indexation will be performed by extracting the text out of the 'value' of the property. }, ... ], dependencies: [ { // Object of type RequirementRef relationship: String, // The user's name on the relationship spaceKey: String, // The requirement's space key: String, // The requirement key baseline: Integer, // The requirement baseline url: String, }, ... ], reverseDependencies: [ { // Object of type RequirementRef relationship: String, // The user's name on the relationship spaceKey: String, // The requirement's space key: String, // The requirement key baseline: Integer, // The requirement baseline url: String, }, ... ], genericUrl: String, destinationUrl: String, searchForVersionsUrl: String, // URL to search for different baselines of the requirement formattingCss: String, // A CSS attribute, converted from the Property "_formatting" using Property.convertToCss(). This value is not saved in the DB, use the properties to save anything formattingNoBorder: Boolean, // True if the "aui-label" border should be removed. False if not, null if unknown. Same as 'formattingCss': It is read-only for the UI; Use the properties to save anything. }, ... ]
Returns		HTTP Response.

RequirementResource3

A Requirement resource that returns requirements in bulk

@PublicApi This API is public. See our policy.

PUT /rest/reqs/1/requirement3/request

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

Returns the list of requirements that match the requests.
Used by Jira.
Example: PUT /rest/reqs/1/requirement3/request

Type	Name	Description
Query param	?fetchDependentPages=...	boolean.
Query param	?limit=...	int.
Body		`[ { // Object of type RequirementResource3.RequirementRequest spaceKey: String, key: String, v: Integer, }, ... ]`
Returns		HTTP Response.

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

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

Not public

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{attachmentId}	Long.
Returns		HTTP Response.

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

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

Not public

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{attachmentId}	Long.
Body		`{ // Object of type WorkbookConfig.IntegrationState }`
Returns		HTTP Response.

DELETE /rest/reqs/1/excel/{spaceKey}/{attachmentId}

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

Not public

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{attachmentId}	Long.
Returns		HTTP Response.

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}

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

Reindexes a page.

Type	Name	Description
Path param	{contentId}	Long.
Returns		Object.

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

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

Returns the list of connected applications

Type	Name	Description
Query param	?url=...	String. since 2.5.0, set to true if you want to filter for this URL.
Query param	?filterJira=...	boolean. since 2.3.1, set to true if you only want Jira instances to be returned.
Returns		HTTP Response.

POST /rest/reqs/1/integration

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

Add an integration

Type	Name	Description
Body		a descriptor of the form IntegrationDescriptor. The serviceID will be randomly assigned. { // Object of type IntegrationDescriptor serviceId: String, applinkId: String, // The applink Id. If provided, the values should be copied over before it is used. label: String, displayUrl: String, rpcUrl: String, endpoint: String, userKey: String, // userKey => String value of the UserKey It is persisted in the database username: String, // The username matching the userKey. Only filled before sending to the UI. Only used in the UI, and on The username is configured in the admin tab of requirements yogi. The user should be authenticated in the remote app. We will impersonate this user to post requests to the remote app. version: int, // Version of the API exposed by the third party. See ExternalIntegrationsManager for version info.APIVersions#getAPIVersions() countMessagesInQueue: long, // Count of messages awaiting to be read. status: String, // AOIntegration#STATUS_DISABLED }
Returns		HTTP Response. the IntegrationDescriptor

GET /rest/reqs/1/integration/{serviceId}

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

Get the details of an integration.
We don't check for the permissions, because if
a user is not admin, we don't return the full descriptor.

Type	Name	Description
Path param	{serviceId}	String. the Service ID
Query param	?url=...	String. the base url, if the service ID is null.
Returns		HTTP Response. the descriptor

POST /rest/reqs/1/integration/{serviceId}/check-applinks

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

Checks and updates all the application links, and returns the list for display in global-admin.vm.
User must be global administrator.

Type	Name	Description
Returns		HTTP Response.

POST /rest/reqs/1/integration/{serviceId}/authenticate-user

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

Not public

Type	Name	Description
Path param	{serviceId}	String.
Body		`{ // Object of type AuthenticateUserInJiraPayload username: String, // The username of the person to connect to Jira with. checkUpgrade: boolean, performUpgrade: boolean, performUpgradeIfAuto: boolean, // Performs the update if and only if Jira has the applink configured in Auto mode desiredVersion: Integer, // Desired version if performUpgrade = true. By default, it is the latest supported version. }`
Returns		HTTP Response.

POST /rest/reqs/1/integration/{serviceId}/change-version

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

This resource changes the version of the descriptor in Confluence, and attempts to notify Jira.
We couldn't merge this code with authenticate-user, because the primary goal is to update our local
descriptor, and not fail if we can't connect to Jira;
We couldn't merge this code with update(), because update() returns the descriptor without additional properties,
and we needed to return error/warn/info messages.

Type	Name	Description
Path param	{serviceId}	String.
Query param	?version=...	Integer.
Query param	?status=...	String.
Returns		HTTP Response.

PUT /rest/reqs/1/integration/{serviceId}

@PublicApi This API is public. See our policy.

Update the descriptor. Also called by Jira.

Type	Name	Description
Path param	{serviceId}	String.
Query param	?url=...	String.
Query param	?fields=...	String. the fields to update, separated by a comma. Example: "version,status,endpoint,username"
Body		{ // Object of type IntegrationDescriptor serviceId: String, applinkId: String, // The applink Id. If provided, the values should be copied over before it is used. label: String, displayUrl: String, rpcUrl: String, endpoint: String, userKey: String, // userKey => String value of the UserKey It is persisted in the database username: String, // The username matching the userKey. Only filled before sending to the UI. Only used in the UI, and on The username is configured in the admin tab of requirements yogi. The user should be authenticated in the remote app. We will impersonate this user to post requests to the remote app. version: int, // Version of the API exposed by the third party. See ExternalIntegrationsManager for version info.APIVersions#getAPIVersions() countMessagesInQueue: long, // Count of messages awaiting to be read. status: String, // AOIntegration#STATUS_DISABLED }
Returns		HTTP Response.

DELETE /rest/reqs/1/integration/{serviceId}

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

Delete the descriptor

Type	Name	Description
Path param	{serviceId}	String.
Returns		HTTP Response.

GET /rest/reqs/1/integration/{serviceId}/queue/outbound

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

Gets the elements of the queue.
Note: The best way to get those items is to listen to the webhook and return
successfully.

Type	Name	Description
Path param	{serviceId}	String.
Query param	?limit=...	Integer.
Query param	?includeDone=...	boolean.
Query param	?includeLastResponse=...	boolean.
Returns		HTTP Response.

DELETE /rest/reqs/1/integration/{serviceId}/queue/outbound/{messageId}

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

Delete one item.

Required permission: Confluence administrator

Type	Name	Description
Path param	{serviceId}	String.
Path param	{messageId}	int.
Returns		HTTP Response.

PUT /rest/reqs/1/integration/{serviceId}/queue/outbound/{messageId}

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

Process one item.

Required permission: Confluence administrator

Type	Name	Description
Path param	{serviceId}	String.
Path param	{messageId}	int.
Returns		HTTP Response.

GET /rest/reqs/1/integration/{serviceId}/queue/flush

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

Attempts to flush the queue

Type	Name	Description
Path param	{serviceId}	String.
Returns		HTTP Response.

GET /rest/reqs/1/integration/{serviceId}/queue/inbound

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

Accept messages about the integration, to remove/reset/add links.
Note that if a message fails, all following messages will be returned as NOT_EXECUTED.

Type	Name	Description
Path param	{serviceId}	String. the service that's integrating
Query param	?url=...	String. if the service is null, please provide the base URL of the application and we'll try to match.
Returns		HTTP Response. a list of Answer

POST /rest/reqs/1/integration/{serviceId}/queue/inbound

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

Accept messages about the integration, to remove/reset/add links.
Note that if a message fails, all following messages will be returned as NOT_EXECUTED.

Type	Name	Description
Path param	{serviceId}	String. the service that's integrating
Query param	?url=...	String. if the service is null, please provide the base URL of the application and we'll try to match.
Body		the list of InboundQueueMessage `[ { // Object of type QueueMessage.InboundQueueMessage operation: String, // The operation.InEvent title: String, // Title of the remote object (Optional) templateId: Integer, }, ... ]`
Returns		HTTP Response. a list of Answer

GET /rest/reqs/1/integration/{serviceId}/applink/test

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

Not public

Type	Name	Description
Path param	{serviceId}	String.
Returns		HTTP Response.

IssueTemplatesResource

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

GET /rest/reqs/1/templates/{spaceKey}/

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

Return templates for a given spaceKey

Type	Name	Description
Path param	{spaceKey}	String.
Returns		HTTP Response.

POST /rest/reqs/1/templates/{spaceKey}/

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

Not public

Type	Name	Description
Path param	{spaceKey}	String.
Body		`{ // Object of type IssueTemplate id: int, // Active Object generated ID spaceKey: String, title: String, applinkId: String, projectId: long, issueTypeId: long, relationship: String, fields: String, groupAll: boolean, projectMetadata: String, // Stringify Json: { projectKey: key, projectIconUrl: url, issueTypeName: BUG, issueTypeIconUrl: url } Keep it sync'ed !! }`
Returns		HTTP Response.

PUT /rest/reqs/1/templates/{spaceKey}/{id}

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

Not public

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{id}	int.
Body		`{ // Object of type IssueTemplate id: int, // Active Object generated ID spaceKey: String, title: String, applinkId: String, projectId: long, issueTypeId: long, relationship: String, fields: String, groupAll: boolean, projectMetadata: String, // Stringify Json: { projectKey: key, projectIconUrl: url, issueTypeName: BUG, issueTypeIconUrl: url } Keep it sync'ed !! }`
Returns		HTTP Response.

DELETE /rest/reqs/1/templates/{spaceKey}/{id}

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

Not public

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{id}	int.
Returns		HTTP Response.

GET /rest/reqs/1/templates/{spaceKey}/{id}/issues

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

Not public

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{id}	int.
Query param	?offset=...	int.
Returns		HTTP Response.

JiraResources

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

GET /rest/reqs/1/integration/{serviceId}/jira/projects

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

Not public

Type	Name	Description
Path param	{serviceId}	String.
Returns		HTTP Response.

GET /rest/reqs/1/integration/{serviceId}/jira/projects/{projectKey}/meta

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

Not public

Type	Name	Description
Path param	{serviceId}	String.
Path param	{projectKey}	String.
Returns		HTTP Response.

GET /rest/reqs/1/integration/{serviceId}/jira/projects/{projectKey}/relationships

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

Not public

Type	Name	Description
Path param	{serviceId}	String.
Path param	{projectKey}	String.
Returns		HTTP Response.

POST /rest/reqs/1/integration/{serviceId}/jira/create-issues-bulk

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

Not public

Type	Name	Description
Path param	{serviceId}	String.
Body		{ // Object of type IssuesCreationRequestFromUI issueTemplate: { // Object of type IssueTemplate id: int, // Active Object generated ID spaceKey: String, title: String, applinkId: String, projectId: long, issueTypeId: long, relationship: String, fields: String, groupAll: boolean, projectMetadata: String, // Stringify Json: { projectKey: key, projectIconUrl: url, issueTypeName: BUG, issueTypeIconUrl: url } Keep it sync'ed !! }, issueRequests: [ { // Object of type JiraConfluenceSharedBeans.IssueRequest requirements: [ { // Object of type JiraConfluenceSharedBeans.Requirement key: String, spaceKey: String, baseline: Integer, htmlExcerpt: String, relationship: String, }, ... ], issueFields: [ { // Object of type JiraConfluenceSharedBeans.IssueField fieldName: String, value: String, values: [ { // Object of type java.lang.String value: [ , ... ], coder: byte, hash: int, }, ... ], }, ... ], issueKey: String, createNew: boolean, }, ... ], oneForAll: boolean, isCreateOperation: boolean, }
Returns		HTTP Response.

GET /rest/reqs/1/integration/{serviceId}/jira/issues

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

Fetches the status of Jira issues. Permissions are those of Jira

Type	Name	Description
Path param	{serviceId}	String. the applink ID
Query param	?issues=...	String. the list of issue keys, comma-separated
Returns		HTTP Response.

JiraSyncResource

@deprecated since 1.10.1 (January 2018) - Do not use

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

POST /rest/reqs/1/sync

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

@deprecated since 1.10.1 (January 2018) - This method only works for Jira, since it only filters TYPE_JIRA

Type	Name	Description
Query param	?from=...	String.
Body		String.
Returns		HTTP Response.

LongRunningTaskResource

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

GET /rest/reqs/1/tasks/status/{taskId}

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

Not public

Type	Name	Description
Path param	{taskId}	String.
Returns		HTTP Response.

GET /rest/reqs/1/tasks/jobs

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

Get the currently-running jobs, directly from Jira, for the current user.
tasks/jobs.. It's ugly i know... The difference between a task and a job is the task is a long-running-task
in Confluence, the job is a jira job.

Type	Name	Description
Query param	?applinkId=...	String.
Returns		HTTP Response.

GET /rest/reqs/1/tasks/jobs/{jobId}

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

Get the details of one job, from Jira, for the current user.
tasks/jobs.. It's ugly i know... The difference between a task and a job is the task is a long-running-task
in Confluence, the job is a jira job.

Type	Name	Description
Path param	{jobId}	int.
Query param	?applinkId=...	String.
Returns		HTTP Response.

POST /rest/reqs/1/tasks/jobs/{jobId}/abort

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

Abort a job, assuming the current user has permissions.
tasks/jobs.. It's ugly i know... The difference between a task and a job is the task is a long-running-task
in Confluence, the job is a jira job.

Type	Name	Description
Path param	{jobId}	int.
Query param	?applinkId=...	String.
Returns		HTTP Response.

DELETE /rest/reqs/1/tasks/jobs/{jobId}

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

Clean up the details of a job, once the user has seen the results.

Type	Name	Description
Path param	{jobId}	int.
Query param	?applinkId=...	String.
Returns		HTTP Response.

PUT /rest/reqs/1/tasks/status/{taskId}/pages/{id}

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

Not public

Type	Name	Description
Path param	{taskId}	String.
Path param	{id}	Long.
Body		`{ // Object of type java.util.Map<java.lang.String,java.lang.Object> }`
Returns		HTTP Response.

DELETE /rest/reqs/1/tasks/{taskId}

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

Aborts the task and stop its tracking

Type	Name	Description
Path param	{taskId}	String.
Returns		HTTP Response.

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

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

Returns the history of a requirement.
For each requirement always returns the most recent version first (null/ACTIVE, if exists),
then the older ones, down to v1.

Type	Name	Description
Path param	{spaceKey}	String.
Query param	?reqs=...	`[ { // Object of type java.lang.String value: [ , ... ], coder: byte, hash: int, }, ... ]`
Query param	?expand=...	String.
Returns		HTTP Response.

GET /rest/reqs/1/misc/{spaceKey}/uiSearch

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

@PublicAPI – Read our API policy

Search for requirements.

Type	Name	Description
Path param	{spaceKey}	String. The space key in the URL path. It is only used for information purpose. If the other spaceKey is missing, and if the option "Isolate Spaces" is ticked in the administration, then the search is restricted to this space. Can be "*".
Query param	?q=...	String. the search query, in the Search Syntax format (see Search Syntax).
Query param	?spaceKey=...	String. Comma-separated list, or "*" to ignore spaces. Restricts the search to this specific space. If null, and if the option "isolate spaces" is ticked, then it is defaulted to the current space.
Query param	?offset=...	Integer. Used for pagination
Query param	?limit=...	Integer. Used for pagination
Query param	?includeBaselined=...	boolean.
Query param	?includeArchived=...	boolean. Whether the archived requirements should be included. By default (false), only current (ACTIVE) requirements are displayed, unless there is a reason not to (such as a baselineCondition).
Query param	?baselineCondition=...	String. Restrict the search to these specific baselines.
Query param	?sort=...	String. The SQL ORDER BY clause, by default "REQKEY ASC, BASELINE DESC"
Query param	?order=...	String. Do not use.
Returns		HTTP Response. a RequirementSearchResult that contains => the search result, the suggestion filter, permissions, and whether the plugin RYTest is active

GET /rest/reqs/1/misc/{spaceKey}/{pageId}

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

Returns the list of requirements on the current page.

This method exists to optimize the execution time of the macro: It allows the macro to have no access to the database.

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{pageId}	long.
Query param	?numberOfRequirements=...	Integer.
Returns		HTTP Response.

POST /rest/reqs/1/misc/{spaceKey}/migrateUsersQueries

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

Not public

Type	Name	Description
Path param	{spaceKey}	String.
Returns		HTTP Response.

PUT /rest/reqs/1/misc/{spaceKey}/uiTraceability

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

A REST resource to help the UI of the traceability matrix.

Type	Name	Description
Returns		HTTP Response.

GET /rest/reqs/1/misc/{spaceKey}/traceability/data

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

Get a traceability matrix.. administrators only.

@deprecated since 2.5.10 - See {@link TraceabilityResource}

Type	Name	Description
Path param	{spaceKey}	String.
Query param	?limit=...	Integer.
Returns		HTTP Response.

GET /rest/reqs/1/misc/{spaceKey}/traceability/data/{id}

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

Get a traceability matrix.. administrators only.

@deprecated since 2.5.10 - See {@link TraceabilityResource}

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{id}	int.
Returns		HTTP Response.

GET /rest/reqs/1/misc/{spaceKey}/dependency

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

For test purposes

Type	Name	Description
Path param	{spaceKey}	String.
Query param	?query=...	String. the query string, for example "key~'REQ-10%'"
Returns		HTTP Response.

GET /rest/reqs/1/misc/{spaceKey}/refreezeDependencies

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

Returns a MultiMap (key: relationship, values: requirementRef) to show the dependencies that should be added to the new baseline if we are refreezing

Type	Name	Description
Path param	{spaceKey}	String.
Query param	?requirementQuery=...	String.
Returns		HTTP Response.

GET /rest/reqs/1/misc/{spaceKey}/extended-mode

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

Tells whether we use the RY-554's extended mode, which allows special characters in requirement keys.

Type	Name	Description
Returns		HTTP Response. true/false as a string (with double-quotes, it's a JSON string.

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}

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

Not public

Type	Name	Description
Path param	{settingsName}	String.
Body		String.
Returns		Object.

POST /rest/reqs/1/onboarding/notifications

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

Not public

Type	Name	Description
Query param	?sendeveryone=...	boolean.
Returns		Object.

PersonalQueueResource

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

GET /rest/reqs/1/personal-queue

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

Not public

Type	Name	Description
Returns		HTTP Response.

DELETE /rest/reqs/1/personal-queue/{serviceId}/{messageId}

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

Deletes a message from the queue, after checking we own it.

Type	Name	Description
Path param	{serviceId}	String.
Path param	{messageId}	int.
Returns		HTTP Response.

PUT /rest/reqs/1/personal-queue/{serviceId}/{messageId}

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

Deletes a message from the queue, after checking we own it.

Type	Name	Description
Path param	{serviceId}	String.
Path param	{messageId}	int.
Returns		HTTP Response.

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

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

This method is used for the "Fix broken Jira links" screen in the space reindex.
It returns the list of Jira issues which start with this issue key, and whether Jira finds this
issue.
Requires space-admin permissions

Type	Name	Description
Query param	?q=...	String.
Query param	?limit=...	Integer.
Returns		HTTP Response.

DELETE /rest/reqs/1/repair/jiralinks

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

This method is used for the "Fix broken Jira links" screen in the space reindex.
It returns the list of Jira issues which start with this issue key, and whether Jira finds this
issue.
Requires space-admin permissions

Type	Name	Description
Query param	?applink=...	String.
Query param	?issue=...	String.
Query param	?spaceKey=...	String.
Query param	?key=...	String.
Query param	?baseline=...	Integer.
Query param	?relationship=...	String.
Returns		HTTP Response.

RequirementResource

Deprecated. Use /requirement2 instead.RequirementResource2

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

GET /rest/reqs/1/requirement/{key}

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

@deprecated use /requirement2/{spaceKey}

Type	Name	Description
Path param	{key}	String.
Query param	?expand=...	String.
Returns		HTTP Response.

DELETE /rest/reqs/1/requirement/{key}

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

@deprecated use /requirement2/{spaceKey}

Type	Name	Description
Path param	{key}	String.
Returns		HTTP Response.

PUT /rest/reqs/1/requirement/{key}

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

This is the key place where we write the requirement description

@deprecated use /requirement2/{spaceKey}

Type	Name	Description
Path param	{key}	String.
Body		{ // Object of type Requirement id: int, key: String, spaceKey: String, baseline: Integer, // The baseline of the requirement. It's either the actual baseline, or the latest baseline number of the space. baselineDetails: { // Object of type Baseline baseline: Integer, spaceKey: String, name: String, pageId: Long, // Optional. The page where the release is described. count: Integer, // Optional. The number of requirements in this baseline. pageCount: Integer, // Optional. The number of pages frozen by this baseline. pageUrl: String, // Optional. The url of the page where the release is described, omitting the contextPath. indexUrl: String, // The url of the list-baselines.action page, omitting the contextPath. canonicalUrl: String, // The url of the page, or, by default, the indexUrl }, newSpaceKey: String, status: String, htmlExcerpt: String, htmlNeedsUpdating: boolean, page: { // Object of type PageRef pageId: Long, version: Long, // The version of the page. This is useful when a link points to an older version of a page. We don't use the ceoid of the older version, just the sequential number. occurrence: Integer, // The occurrence # on the page. Since 2.5.1, the default value is null for original links, and 1 for dependent links. It was modified like this // because some algo needed to know whether 'null' was because it was the first dependency, or null because it was an original. // However, the 'null' value didn't change in the DB. Before 2.5.1, the spec was that the first is null, and second is 2, 3, 4... There is no 0, no 1, // although they would display properly if there were some. dependencyId: Integer, // An integer, showing the ID of the REQ-to-REQ dependency covering this PageRef. }, // @deprecated Since 2.0.0, use 'origin' instead origin: { // Object of type Ref title: String, // The title of the document. Free text for the user. Generally contains the page or attachment name and its version, if any. Optional. Generally set after we've retrieved the reference. url: String, // The URL. Must contain the contextPath if it is relatived. Can also be absolute. We've changed in 2.3, we used to add the contextPath() when displaying this url, but the external integrations made us remove it, so we require a URL that can stand on its own. Optional. Generally set after we've retrieved the reference. type: String, // The type of reference. It is compared to hardcoded strings everywhere in js, because js doesn't have access to the class name. Known types: "excel" "jira" "imported" any Confluence CEO type ("draft", "page", "blog", etc.) "deleted" }, // The place where the requirement is defined. Can be an ExcelRef or a PageRef. duplicateOriginalPages: [ { // Object of type Ref title: String, // The title of the document. Free text for the user. Generally contains the page or attachment name and its version, if any. Optional. Generally set after we've retrieved the reference. url: String, // The URL. Must contain the contextPath if it is relatived. Can also be absolute. We've changed in 2.3, we used to add the contextPath() when displaying this url, but the external integrations made us remove it, so we require a URL that can stand on its own. Optional. Generally set after we've retrieved the reference. type: String, // The type of reference. It is compared to hardcoded strings everywhere in js, because js doesn't have access to the class name. Known types: "excel" "jira" "imported" any Confluence CEO type ("draft", "page", "blog", etc.) "deleted" }, ... ], references: [ { // Object of type PageRef pageId: Long, version: Long, // The version of the page. This is useful when a link points to an older version of a page. We don't use the ceoid of the older version, just the sequential number. occurrence: Integer, // The occurrence # on the page. Since 2.5.1, the default value is null for original links, and 1 for dependent links. It was modified like this // because some algo needed to know whether 'null' was because it was the first dependency, or null because it was an original. // However, the 'null' value didn't change in the DB. Before 2.5.1, the spec was that the first is null, and second is 2, 3, 4... There is no 0, no 1, // although they would display properly if there were some. dependencyId: Integer, // An integer, showing the ID of the REQ-to-REQ dependency covering this PageRef. }, ... ], tests: { // Object of type java.util.Map<java.lang.String,java.util.List<com.playsql.requirementyogi.api.beans.TestRef>> }, // Tests are always in anti-chronological order: The first is the most recent test. issues: [ { // Object of type JiraRef applink: String, issueKey: String, relationship: String, title: String, url: String, status: String, issueTemplateId: Integer, }, ... ], properties: [ { // Object of type Property type: { // Object of type Property.Type }, // All our properties are currently in AUTO mode key: String, // The key, in UTF-8 value: String, // Value, as HTML. Necessary for the property to be saved. searchUrl: String, // The search url (without the context path) if one wants to search by this property. Optional. display: boolean, indexation: { // Object of type PropertyIndexation text: String, // Internal. The indexation value, if it is a simple string. It must be null if 'multivalues' is used. multivalues: [ { // Object of type java.lang.String value: [ , ... ], coder: byte, hash: int, }, ... ], // Internal. Same as #text, but when it is a list. userMentions: [ { // Object of type java.lang.String value: [ , ... ], coder: byte, hash: int, }, ... ], // Internal. Same as #userMentions, but when it is a list. }, // Pre-parsed values to use for the search queries. Optional. This is only used when saving the excerpt of a requirement. This is not guaranteed to be present when reading a requirement from the DB. Please do not use outside the core of requirement yogi, the details may change without notice. If missing, then indexation will be performed by extracting the text out of the 'value' of the property. }, ... ], dependencies: [ { // Object of type RequirementRef relationship: String, // The user's name on the relationship spaceKey: String, // The requirement's space key: String, // The requirement key baseline: Integer, // The requirement baseline url: String, }, ... ], reverseDependencies: [ { // Object of type RequirementRef relationship: String, // The user's name on the relationship spaceKey: String, // The requirement's space key: String, // The requirement key baseline: Integer, // The requirement baseline url: String, }, ... ], genericUrl: String, destinationUrl: String, searchForVersionsUrl: String, // URL to search for different baselines of the requirement formattingCss: String, // A CSS attribute, converted from the Property "_formatting" using Property.convertToCss(). This value is not saved in the DB, use the properties to save anything formattingNoBorder: Boolean, // True if the "aui-label" border should be removed. False if not, null if unknown. Same as 'formattingCss': It is read-only for the UI; Use the properties to save anything. }
Returns		HTTP Response.

PUT /rest/reqs/1/requirement

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

Not public

Type	Name	Description
Body		`{ // Object of type java.util.Date }`
Returns		HTTP Response.

RteResource

A resource for anything managed in the Rich Text Editor

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

POST /rest/reqs/1/rte/{spaceKey}/suggestAtInitialization

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

@InternalAPI – Not intended for use by customers

Returns the next available key for each req.
Initializes the suggestion popup, by suggesting the next requirement for each key root.
Needs to be a post because we use the body of the request

Type	Name	Description
Path param	{spaceKey}	String.
Body		`[ { // Object of type java.lang.String value: [ , ... ], coder: byte, hash: int, }, ... ]`
Returns		HTTP Response.

GET /rest/reqs/1/rte/{spaceKey}/suggest2

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

@InternalAPI – Read our API policy

Both search for requirements and provide suggestions for keys. This resource is only used in the RTE.

Type	Name	Description
Path param	{spaceKey}	String. the space key in the URL path. If the option "Isolate Spaces" is ticked in the administration, then the search is restricted to this space. Can be "*".
Query param	?q=...	String. the text entered by the user. This is NOT using the "Search Syntax". We'll return the keys matching exactly this text first, then the keys starting with this text, then requirements containing this text.
Query param	?includeArchived=...	boolean. Whether the archived requirements should be included. By default (false), only current (ACTIVE) requirements are displayed, unless there is a reason not to (such as a baselineCondition).
Query param	?suggest=...	Integer. The number of suggestions that can be returned for keys. Default is 0. If > 0, it will take the requirements returned by the search for this space, add 1 until we find one that doesn't exist. It is quite expensive in terms of resources, so please do not use lightly.
Returns		HTTP Response.

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

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

Transform a RYReportMacro into static content.

Type	Name	Description
Path param	{spaceKey}	String. the current space key, required
Query param	?query=...	String. the search query string, optional default value is null
Query param	?includeDeleted=...	boolean. Boolean, whether we should only return active requirements, optional by default it is false
Query param	?crossSpace=...	boolean.
Query param	?displayMode=...	String. String, possible values: "results_only, search_only, search_and_results", required
Query param	?columns=...	String. Comma-separated list of columns to render, optional by default the result report will contain three columns: key, description, links
Query param	?sameSpace=...	boolean. A Boolean to determine if we search cross space or not
Query param	?ceoId=...	String.
Returns		HTTP Response.

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

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

Transform a RYReportMacro into static content.

Type	Name	Description
Path param	{spaceKey}	String. the current space key, required
Query param	?query=...	String. the search query string, optional, default value is null
Query param	?includeDeleted=...	boolean. Boolean, whether we should only return active requirements, optional, default value is false
Query param	?savedQueryId=...	String. the saved query ID, optional
Query param	?savedQuerySpaceKey=...	String. The space key of the savedQueryId, optional
Query param	?withJira=...	boolean.
Query param	?crossSpace=...	boolean.
Query param	?columnsJson=...	String. A Json representation of the matrix columns to render, required
Returns		HTTP Response.

SettingsResource

CRUD API for settings.

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

GET /rest/reqs/1/settings

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

Not public

Type	Name	Description
Returns		Object.

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

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

Not public

Type	Name	Description
Path param	{settingsName}	String.
Returns		Object.

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

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

Not public

Type	Name	Description
Path param	{settingsName}	String.
Body		String.
Returns		Object.

PUT /rest/reqs/1/settings

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

Not public

Type	Name	Description
Body		`{ // Object of type java.util.Map<java.lang.String,java.lang.String> }`
Returns		HTTP Response.

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}/

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

Returns the current user's own matrixes. I want, in a near future, to return all visible queries of this user.

Type	Name	Description
Path param	{spaceKey}	String.
Query param	?limit=...	Integer. the limit, or -1
Returns		HTTP Response.

GET /rest/reqs/1/traceability/{spaceKey}/{id}

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

Reads a traceability matrix. If you have permissions.

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{id}	int.
Returns		HTTP Response.

POST /rest/reqs/1/traceability/{spaceKey}

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

Saves a traceability matrix for the first time. It will return with a generated ID.

Type	Name	Description
Path param	{spaceKey}	String.
Body		String.
Returns		HTTP Response.

PUT /rest/reqs/1/traceability/{spaceKey}/{id}

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

Updates a traceability matrix

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{id}	int.
Body		String.
Returns		HTTP Response.

DELETE /rest/reqs/1/traceability/{spaceKey}/{id}

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

Deletes a traceability matrix

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{id}	int.
Returns		HTTP Response.

PUT /rest/reqs/1/traceability/{spaceKey}/uiTraceability

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

A REST resource to help the UI of the traceability matrix.

Type	Name	Description
Path param	{spaceKey}	String.
Query param	?q=...	String.
Query param	?limit=...	Integer.
Query param	?includeBaselined=...	boolean.
Query param	?includeArchived=...	boolean.
Query param	?withJira=...	boolean.
Query param	?crossSpace=...	boolean.
Body		`{ // Object of type TraceabilityResource.TraceabilityUIRenderRequest traceabilityMatrixColumns: String, offsetJson: String, }`
Returns		HTTP Response.

TypesResource

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

GET /rest/reqs/1/types/{spaceKey}

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

This method is going to be slow, or cache a lot of data, if there are a lot of requirements in the space.
This is ok, because they inline popup is an advanced feature.

Type	Name	Description
Path param	{spaceKey}	String. the space key
Query param	?refresh=...	boolean.
Returns		HTTP Response. the list

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

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

Create a requirement/several requirements with the details provided in ReplacementRequest, then
proceeds to replacing the occurrence on every page of the space (if requested).

Type	Name	Description
Path param	{spaceKey}	String. the space key
Body		the details of the replacement { // Object of type ReplacementRequest reqKey: String, // The requirement key to create description: String, // The description sourceCeoId: Long, // The source page, where all requirements with this key must be replaced applyToAllSimilarOccurrences: boolean, applyToAllSpace: boolean, defineInline: boolean, // If defineInline, then sourceCeoId is present. defineInlineAsALink: boolean, // If defineInlineAsALink, then sourceCeoId is present. typeName: String, // The type formatting: String, // The formatting. Only applies if the table is created. pattern: String, // The pattern. Only applies if applyToAllSimilarOccurrences. targetCeoId: Long, // The page where keys for this type are stored }
Returns		HTTP Response.

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

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

Not public

Type	Name	Description
Path param	{spaceKey}	String.
Body		`{ // Object of type TypeResourceCreationRequest reqKey: String, typeName: String, ceoId: Long, description: String, formatting: String, }`
Returns		HTTP Response.

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}

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

Uninstalls RY requirement macros from a page.

Type	Name	Description
Path param	{pageId}	Long.
Returns		HTTP Response.

REST API

REST APIs for Requirement Yogi (Confluence)

BaselineResource

RequirementResource2

RequirementResource3

ExcelResource

HelpersResource

IntegrationResource

IssueTemplatesResource

JiraResources

JiraSyncResource

LongRunningTaskResource

MiscResource

OnboardingResource

PersonalQueueResource

RepairResource

RequirementResource

RteResource

SettingsResource

TraceabilityResource

TypesResource

UninstallResource