REST API

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

@PublicApi This API is public. See our policy.

Search for baselines.

@since 2.6.3 and since APIv9.

Type	Name	Description
Query param	?q=...	String.
Query param	?spaceKeys=...	String. the (comma-separated) list of spaces where the search needs to be made
Query param	?limit=...	Integer.
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 SpaceAndBaseliness.

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}

@PublicApi This API is public. See our policy.

Returns the details of one baseline

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

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.
Query param	?limit=...	Integer.
Returns		HTTP Response. a list of pages.

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

@PublicApi This API is public. See our policy.

Creates a baseline, but does not freeze it.

This method will generate a unique number for this baseline, therefore it requires a cluster lock. It will create it as BaselineStatus#PREVIEW.

This method will read from the provided object:

spaceKey
name
pageId (optional)
searchQuery (optional)
parentBaseline (optional)
refreezeProperties (optional)

This method will ignore the server-controlled fields of the Baseline object, i.e. history, requirementCount, pageCount, urls, etc.

Please call /baseline-actions/freeze after creating this baseline.

Type	Name	Description
Path param	{spaceKey}	String.
Body		{ // Object of type CreationPayload baseline: { // Object of type Baseline baseline: Integer, spaceKey: String, name: String, status: { // Object of type BaselineStatus }, // The baseline status. Use BaselineStatus#NON_EXISTING if it's a mock object which doesn't represent an actual object in the database. pageId: Long, // Optional. The page where the release is described. count: Integer, // Optional. The number of actual requirements in this baseline (already-frozen). 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 searchUrl: String, // The url of the search for requirements of this baseline history: [ { // Object of type BaselineHistoryRecord authorKey: String, // UserKey of the author of the change date: Long, // Date of creation, result of java.util.Date status: String, // The new status of the baseline fields: { // Object of type java.util.Map<java.lang.String,java.lang.Object> }, // List of fields which were modified }, ... ], // The history of the baseline searchQuery: String, // The search query that created this baseline. Optional, will be null if the baseline was created before RY 3.0.10 or if 'parentBaseline' is non-null. parentBaseline: Integer, // Baseline number of the baseline that was used to refreeze this one. refreezeProperties: { // Object of type RefreezeProperties addQuery: String, // RY search query of requirements which should be added to the baseline. The space can be omitted. Their version must be specified (even for current requirements), it is NOT similar to a normal search's implicit ACTIVE requirements. Optional. If null, then no requirement will be added. The empty string is not accepted, because it is error-prone. removeQuery: String, // RY requirements to remove from the baseline. The space and baseline can be omitted from the query, since we'll remove anything that matches those criteria. If there is a conflict with the addQuery, then requirements of the addQuery win. Optional. If null, no requirement will be removed. The empty string is not accepted, because it is error-prone. }, // If the baseline is refrozen, and if 'parentBaseline' is filled, then 'refreezeProperties' contains the properties of the refreeze. progress: { // Object of type FreezeProgress percentProgress: int, // The percentage of progress, betweeo 0 and 100. Even if we try not to, it may happen that it is 100 and the baseline isn't done, so don't rely on the "100" value. estimatedTotal: Integer, // Estimated number of requirements to land in this baseline. Null if never estimated. aborted: boolean, // True if the background task should be aborted. errorType: { // Object of type BaselineCreationException.Situation }, // If the baseline is in an ERROR status and it came from a BaselineCreationException, the type will be written here. recoveryAction: String, // If errorType is present and a recovery action is possible, it will be written here. recoveryQuery: String, }, // Progress of the freeze. Optional, only present if the status is IN_CREATION. }, // The baseline to create, obviously. Mandatory. createBaselinePage: boolean, // If true, then a summary page will be created for this baseline, based on the blueprint. generateQueryFromPageId: Long, // If set, the search query will be overridden with 'page = ...' generateQueryWithChildren: Boolean, // If generateQueryFromPageId has a value, then this will add all children of the current page. }
Returns		HTTP Response.

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

@PublicApi This API is public. See our policy.

Updates a baseline.

The spaceKey and baseline number passed in parameter must match the URL.

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{version}	int.
Query param	?fields=...	String. comma-separated list of fields to update. Compulsory. One of: SEARCHQUERY, NAME, PAGEID, PARENTBASELINE, REFREEZEPROPERTIES, STATUS (in which case, for a transition from ERROR-to-PREVIEW or PREVIEW-to-PREVIEW, it will abort the task and recalculate the expected counts).
Body		{ // Object of type Baseline baseline: Integer, spaceKey: String, name: String, status: { // Object of type BaselineStatus }, // The baseline status. Use BaselineStatus#NON_EXISTING if it's a mock object which doesn't represent an actual object in the database. pageId: Long, // Optional. The page where the release is described. count: Integer, // Optional. The number of actual requirements in this baseline (already-frozen). 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 searchUrl: String, // The url of the search for requirements of this baseline history: [ { // Object of type BaselineHistoryRecord authorKey: String, // UserKey of the author of the change date: Long, // Date of creation, result of java.util.Date status: String, // The new status of the baseline fields: { // Object of type java.util.Map<java.lang.String,java.lang.Object> }, // List of fields which were modified }, ... ], // The history of the baseline searchQuery: String, // The search query that created this baseline. Optional, will be null if the baseline was created before RY 3.0.10 or if 'parentBaseline' is non-null. parentBaseline: Integer, // Baseline number of the baseline that was used to refreeze this one. refreezeProperties: { // Object of type RefreezeProperties addQuery: String, // RY search query of requirements which should be added to the baseline. The space can be omitted. Their version must be specified (even for current requirements), it is NOT similar to a normal search's implicit ACTIVE requirements. Optional. If null, then no requirement will be added. The empty string is not accepted, because it is error-prone. removeQuery: String, // RY requirements to remove from the baseline. The space and baseline can be omitted from the query, since we'll remove anything that matches those criteria. If there is a conflict with the addQuery, then requirements of the addQuery win. Optional. If null, no requirement will be removed. The empty string is not accepted, because it is error-prone. }, // If the baseline is refrozen, and if 'parentBaseline' is filled, then 'refreezeProperties' contains the properties of the refreeze. progress: { // Object of type FreezeProgress percentProgress: int, // The percentage of progress, betweeo 0 and 100. Even if we try not to, it may happen that it is 100 and the baseline isn't done, so don't rely on the "100" value. estimatedTotal: Integer, // Estimated number of requirements to land in this baseline. Null if never estimated. aborted: boolean, // True if the background task should be aborted. errorType: { // Object of type BaselineCreationException.Situation }, // If the baseline is in an ERROR status and it came from a BaselineCreationException, the type will be written here. recoveryAction: String, // If errorType is present and a recovery action is possible, it will be written here. recoveryQuery: String, }, // Progress of the freeze. Optional, only present if the status is IN_CREATION. }
Returns		HTTP Response.

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.

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}

@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 "KEY 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
{
"providedJson": ["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	?override=...	boolean.
Query param	?pageId=...	Long.
Body		{ // Object of type CreationRequest providedJson: String, spaceKey: String, 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. isCoveredByDependency: boolean, // An integer, showing the ID of the REQ-to-REQ dependency covering this PageRef. }, }
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
Called when saving a page

Type	Name	Description
Path param	{key}	String.
Path param	{spaceKey}	String.
Body		{ // Object of type Requirement id: Long, // The ID of the requirement in the database. It shouldn't be used, except by the Stashes for performance reasons. There is no reason to use it in the UI, and in fact, we'll remove it from REST responses in RY 4.0. It should have been removed in version 3.0, but we had to restore it for one customer who had scripts relying on it.@deprecated To be removed in RY 4.0 (or more precisely, annotated so that its value is not visible in the UI). 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, status: { // Object of type BaselineStatus }, // The baseline status. Use BaselineStatus#NON_EXISTING if it's a mock object which doesn't represent an actual object in the database. pageId: Long, // Optional. The page where the release is described. count: Integer, // Optional. The number of actual requirements in this baseline (already-frozen). 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 searchUrl: String, // The url of the search for requirements of this baseline history: [ { // Object of type BaselineHistoryRecord authorKey: String, // UserKey of the author of the change date: Long, // Date of creation, result of java.util.Date status: String, // The new status of the baseline fields: { // Object of type java.util.Map<java.lang.String,java.lang.Object> }, // List of fields which were modified }, ... ], // The history of the baseline searchQuery: String, // The search query that created this baseline. Optional, will be null if the baseline was created before RY 3.0.10 or if 'parentBaseline' is non-null. parentBaseline: Integer, // Baseline number of the baseline that was used to refreeze this one. refreezeProperties: { // Object of type RefreezeProperties addQuery: String, // RY search query of requirements which should be added to the baseline. The space can be omitted. Their version must be specified (even for current requirements), it is NOT similar to a normal search's implicit ACTIVE requirements. Optional. If null, then no requirement will be added. The empty string is not accepted, because it is error-prone. removeQuery: String, // RY requirements to remove from the baseline. The space and baseline can be omitted from the query, since we'll remove anything that matches those criteria. If there is a conflict with the addQuery, then requirements of the addQuery win. Optional. If null, no requirement will be removed. The empty string is not accepted, because it is error-prone. }, // If the baseline is refrozen, and if 'parentBaseline' is filled, then 'refreezeProperties' contains the properties of the refreeze. progress: { // Object of type FreezeProgress percentProgress: int, // The percentage of progress, betweeo 0 and 100. Even if we try not to, it may happen that it is 100 and the baseline isn't done, so don't rely on the "100" value. estimatedTotal: Integer, // Estimated number of requirements to land in this baseline. Null if never estimated. aborted: boolean, // True if the background task should be aborted. errorType: { // Object of type BaselineCreationException.Situation }, // If the baseline is in an ERROR status and it came from a BaselineCreationException, the type will be written here. recoveryAction: String, // If errorType is present and a recovery action is possible, it will be written here. recoveryQuery: String, }, // Progress of the freeze. Optional, only present if the status is IN_CREATION. }, newSpaceKey: String, status: String, htmlExcerpt: String, htmlNeedsUpdating: boolean, 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. isCoveredByDependency: boolean, // An integer, showing the ID of the REQ-to-REQ dependency covering this PageRef. }, ... ], // @deprecated Since we can have a lot of links, using this property is not recommended. // Also, it is null by default and only filled on demand 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.@deprecated in version 3.0, please use DependencyDAO to retrieve the details of the tests. issues: [ { // Object of type JiraRef applink: String, issueKey: String, relationship: String, title: String, url: String, // Url for JiraRef is the entire URL, with the baseUrl status: String, issueTemplateId: Long, }, ... ], // @deprecated in version 3.0, please use DependencyDAO instead. // Since we can have a lot of links, using this property is not recommended. // Also, it is null by default and only filled on demand. properties: [ { // Object of type Property type: { // Object of type PropertyType }, // Type of the property, a property can be INLINE (created in a page) or EXTERNAL, created in the RY pages Note: Legacy properties (before v3.0.0) are INLINE 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, // If false, the property is not displayed to the user. This is not saved, and it depends on the key starting with '_' dataType: { // Object of type PropertyDataType }, // The type when searching or performing aggregations. By default, it's a string, and values are displayed as HTML. 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. When reading a requirement, this is not guaranteed to be present. If missing, then indexation will be performed by extracting the text out of the 'value' of the property. propertyNameMeta: { // Object of type PropertyNameMeta dropdownItems: { // Object of type java.util.Map<java.lang.String,com.playsql.requirementyogi.api.beans.properties.MetaDropdownOption> }, }, // Property name meta information. It can be null if : - the external property does not require to have meta information (ex DROPDOWN requires it) - the entry point did not ask to fill this information (expand = propertyNameMeta) }, ... ], dependencies: [ { // Object of type RequirementRef relationship: String, // The user's name on the relationship }, ... ], // Dependencies (where 'this' is child) and reverse dependencies (where 'this' is parent). They are only fetched on demand, hence the 'null' value by default.@deprecated It is not recommended to use those anymore, as there can be a lot of dependencies. // Please use DependencyDAO now, to only fetch dependencies when needed. reverseDependencies: [ { // Object of type RequirementRef relationship: String, // The user's name on the relationship }, ... ], 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. isPublicDescription: Boolean, // True if the space administrator has decided that the requirement descriptions can be managed in Jira and are, therefore, public in the sense that everyone can see them. It only has a value if the caller explicitly requests it.@since 3.1.1 / APIv11 }
Returns		HTTP Response.

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

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

Modify requirements

@InternalAPI – Not intended for use by customers

Type	Name	Description
Path param	{spaceKey}	String.
Body		[ { // Object of type Requirement id: Long, // The ID of the requirement in the database. It shouldn't be used, except by the Stashes for performance reasons. There is no reason to use it in the UI, and in fact, we'll remove it from REST responses in RY 4.0. It should have been removed in version 3.0, but we had to restore it for one customer who had scripts relying on it.@deprecated To be removed in RY 4.0 (or more precisely, annotated so that its value is not visible in the UI). 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, status: { // Object of type BaselineStatus }, // The baseline status. Use BaselineStatus#NON_EXISTING if it's a mock object which doesn't represent an actual object in the database. pageId: Long, // Optional. The page where the release is described. count: Integer, // Optional. The number of actual requirements in this baseline (already-frozen). 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 searchUrl: String, // The url of the search for requirements of this baseline history: [ { // Object of type BaselineHistoryRecord authorKey: String, // UserKey of the author of the change date: Long, // Date of creation, result of java.util.Date status: String, // The new status of the baseline fields: { // Object of type java.util.Map<java.lang.String,java.lang.Object> }, // List of fields which were modified }, ... ], // The history of the baseline searchQuery: String, // The search query that created this baseline. Optional, will be null if the baseline was created before RY 3.0.10 or if 'parentBaseline' is non-null. parentBaseline: Integer, // Baseline number of the baseline that was used to refreeze this one. refreezeProperties: { // Object of type RefreezeProperties addQuery: String, // RY search query of requirements which should be added to the baseline. The space can be omitted. Their version must be specified (even for current requirements), it is NOT similar to a normal search's implicit ACTIVE requirements. Optional. If null, then no requirement will be added. The empty string is not accepted, because it is error-prone. removeQuery: String, // RY requirements to remove from the baseline. The space and baseline can be omitted from the query, since we'll remove anything that matches those criteria. If there is a conflict with the addQuery, then requirements of the addQuery win. Optional. If null, no requirement will be removed. The empty string is not accepted, because it is error-prone. }, // If the baseline is refrozen, and if 'parentBaseline' is filled, then 'refreezeProperties' contains the properties of the refreeze. progress: { // Object of type FreezeProgress percentProgress: int, // The percentage of progress, betweeo 0 and 100. Even if we try not to, it may happen that it is 100 and the baseline isn't done, so don't rely on the "100" value. estimatedTotal: Integer, // Estimated number of requirements to land in this baseline. Null if never estimated. aborted: boolean, // True if the background task should be aborted. errorType: { // Object of type BaselineCreationException.Situation }, // If the baseline is in an ERROR status and it came from a BaselineCreationException, the type will be written here. recoveryAction: String, // If errorType is present and a recovery action is possible, it will be written here. recoveryQuery: String, }, // Progress of the freeze. Optional, only present if the status is IN_CREATION. }, newSpaceKey: String, status: String, htmlExcerpt: String, htmlNeedsUpdating: boolean, 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. isCoveredByDependency: boolean, // An integer, showing the ID of the REQ-to-REQ dependency covering this PageRef. }, ... ], // @deprecated Since we can have a lot of links, using this property is not recommended. // Also, it is null by default and only filled on demand 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.@deprecated in version 3.0, please use DependencyDAO to retrieve the details of the tests. issues: [ { // Object of type JiraRef applink: String, issueKey: String, relationship: String, title: String, url: String, // Url for JiraRef is the entire URL, with the baseUrl status: String, issueTemplateId: Long, }, ... ], // @deprecated in version 3.0, please use DependencyDAO instead. // Since we can have a lot of links, using this property is not recommended. // Also, it is null by default and only filled on demand. properties: [ { // Object of type Property type: { // Object of type PropertyType }, // Type of the property, a property can be INLINE (created in a page) or EXTERNAL, created in the RY pages Note: Legacy properties (before v3.0.0) are INLINE 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, // If false, the property is not displayed to the user. This is not saved, and it depends on the key starting with '_' dataType: { // Object of type PropertyDataType }, // The type when searching or performing aggregations. By default, it's a string, and values are displayed as HTML. 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. When reading a requirement, this is not guaranteed to be present. If missing, then indexation will be performed by extracting the text out of the 'value' of the property. propertyNameMeta: { // Object of type PropertyNameMeta dropdownItems: { // Object of type java.util.Map<java.lang.String,com.playsql.requirementyogi.api.beans.properties.MetaDropdownOption> }, }, // Property name meta information. It can be null if : - the external property does not require to have meta information (ex DROPDOWN requires it) - the entry point did not ask to fill this information (expand = propertyNameMeta) }, ... ], dependencies: [ { // Object of type RequirementRef relationship: String, // The user's name on the relationship }, ... ], // Dependencies (where 'this' is child) and reverse dependencies (where 'this' is parent). They are only fetched on demand, hence the 'null' value by default.@deprecated It is not recommended to use those anymore, as there can be a lot of dependencies. // Please use DependencyDAO now, to only fetch dependencies when needed. reverseDependencies: [ { // Object of type RequirementRef relationship: String, // The user's name on the relationship }, ... ], 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. isPublicDescription: Boolean, // True if the space administrator has decided that the requirement descriptions can be managed in Jira and are, therefore, public in the sense that everyone can see them. It only has a value if the caller explicitly requests it.@since 3.1.1 / APIv11 }, ... ]
Returns		HTTP Response.

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

@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.

AccumulatorResource

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

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

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

Returns the result of the formula applied to the properties found with the searchQuery

Type	Name	Description
Path param	{spaceKey}	String. The current spaceKey
Query param	?q=...	String. Query to search requirements, and so the properties
Query param	?includeBaselined=...	boolean. Include the baselined requirements
Query param	?withJira=...	boolean. Include Jira data
Query param	?crossSpace=...	boolean. If the query is cross-spaced
Query param	?matrixType=...	String. One of ESTIMATION or TRACEABILITY: note that accumulators do not work with TRACEABILITY (but no check is implemented)
Query param	?formula=...	String. Here are some examples: SUM(@Estimate) SOMME(SI(@ColumnRatio>1,@ColumnEstimate*@ColumnRatio,0)) AVG(@Estimate) MIN(@Estimate) MAX(@Estimate) COUNT(@Estimate) SI(@Estimate>50,@Estimate,0) COUNT(@Estimate > 50)
Body		TraceabilityUIRenderRequest includes the variables for the currentBaseline `{ // Object of type TraceabilityResource.TraceabilityUIRenderRequest traceabilityMatrixColumns: String, offsetJson: String, variables: { // Object of type java.util.Map<java.lang.String,java.lang.Object> }, }`
Returns		HTTP Response. A map with the { formulas -> result }

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}

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

Freeze an existing baseline.

API subject to change in micro releases.

@since 3.0.10

Type	Name	Description
Path param	{spaceKey}	String. the space key
Path param	{version}	int. the baseline version
Returns		HTTP Response. a JSON containing the taskId. You can poll for readiness using the /baseline/{version} resource.

GET /rest/reqs/1/baseline-actions/{spaceKey}/search

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

Checks the validity of the name for the next baseline

Type	Name	Description
Path param	{spaceKey}	String. the space key
Query param	?baselineName=...	String. the proposed baseline name
Returns		HTTP Response.

GET /rest/reqs/1/baseline-actions/{spaceKey}/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.

POST /rest/reqs/1/baseline-actions/{spaceKey}/pre-refreeze-summary

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

Based on a baseline, suggest dependencies to add.
This API comes from the former /refreezeDependencies API, but we have noticed that its results were not
accurate because:
- If a baseline is bigger than 1 page of requirements, then we can't retrieve the rest of the baseline without
altering the performance of Confluence,
- If the list of removed requirements is bigger than 1 page, we can't properly compile the results without
loading the entire basline in memory.

Important Therefore:
- The results should not be considered accurate,
- We'll only process the 1st page of requirements,
- In case of a refreeze, we'll only process the added requirements.
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. String space key.
Body		{ // Object of type Baseline baseline: Integer, spaceKey: String, name: String, status: { // Object of type BaselineStatus }, // The baseline status. Use BaselineStatus#NON_EXISTING if it's a mock object which doesn't represent an actual object in the database. pageId: Long, // Optional. The page where the release is described. count: Integer, // Optional. The number of actual requirements in this baseline (already-frozen). 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 searchUrl: String, // The url of the search for requirements of this baseline history: [ { // Object of type BaselineHistoryRecord authorKey: String, // UserKey of the author of the change date: Long, // Date of creation, result of java.util.Date status: String, // The new status of the baseline fields: { // Object of type java.util.Map<java.lang.String,java.lang.Object> }, // List of fields which were modified }, ... ], // The history of the baseline searchQuery: String, // The search query that created this baseline. Optional, will be null if the baseline was created before RY 3.0.10 or if 'parentBaseline' is non-null. parentBaseline: Integer, // Baseline number of the baseline that was used to refreeze this one. refreezeProperties: { // Object of type RefreezeProperties addQuery: String, // RY search query of requirements which should be added to the baseline. The space can be omitted. Their version must be specified (even for current requirements), it is NOT similar to a normal search's implicit ACTIVE requirements. Optional. If null, then no requirement will be added. The empty string is not accepted, because it is error-prone. removeQuery: String, // RY requirements to remove from the baseline. The space and baseline can be omitted from the query, since we'll remove anything that matches those criteria. If there is a conflict with the addQuery, then requirements of the addQuery win. Optional. If null, no requirement will be removed. The empty string is not accepted, because it is error-prone. }, // If the baseline is refrozen, and if 'parentBaseline' is filled, then 'refreezeProperties' contains the properties of the refreeze. progress: { // Object of type FreezeProgress percentProgress: int, // The percentage of progress, betweeo 0 and 100. Even if we try not to, it may happen that it is 100 and the baseline isn't done, so don't rely on the "100" value. estimatedTotal: Integer, // Estimated number of requirements to land in this baseline. Null if never estimated. aborted: boolean, // True if the background task should be aborted. errorType: { // Object of type BaselineCreationException.Situation }, // If the baseline is in an ERROR status and it came from a BaselineCreationException, the type will be written here. recoveryAction: String, // If errorType is present and a recovery action is possible, it will be written here. recoveryQuery: String, }, // Progress of the freeze. Optional, only present if the status is IN_CREATION. }
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.

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

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

/external-properties/MAIN/count?q=REQ

Count the total number of item returns by this query

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

PUT /rest/reqs/1/external-properties/{spaceKey}

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

Update value for several requirements (depending a search query)

PUT /external-properties/MAIN?q=XXX

Type	Name	Description
Path param	{spaceKey}	String. key of a space (supports null) Used to check EDIT rights on the space. If null, check if user is a confluence administrator
Query param	?q=...	String. search query to find requirements
Body		Property object containing information { // Object of type Property type: { // Object of type PropertyType }, // Type of the property, a property can be INLINE (created in a page) or EXTERNAL, created in the RY pages Note: Legacy properties (before v3.0.0) are INLINE 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, // If false, the property is not displayed to the user. This is not saved, and it depends on the key starting with '_' dataType: { // Object of type PropertyDataType }, // The type when searching or performing aggregations. By default, it's a string, and values are displayed as HTML. 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. When reading a requirement, this is not guaranteed to be present. If missing, then indexation will be performed by extracting the text out of the 'value' of the property. propertyNameMeta: { // Object of type PropertyNameMeta dropdownItems: { // Object of type java.util.Map<java.lang.String,com.playsql.requirementyogi.api.beans.properties.MetaDropdownOption> }, }, // Property name meta information. It can be null if : - the external property does not require to have meta information (ex DROPDOWN requires it) - the entry point did not ask to fill this information (expand = propertyNameMeta) }
Returns		HTTP Response. Property

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

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

Updates the value of the property name with EXTERNAL type for a given requirement

Example:

PUT /external-properties/MAIN/REQ-001

Type	Name	Description
Path param	{spaceKey}	String. The space key should be URI encoded (supports null) (js ex: encodeURIComponent()). Used to check EDIT rights on the space. If null, check if user is a confluence administrator.
Path param	{key}	String. The requirement key should be URI encoded (js ex: encodeURIComponent())
Query param	?v=...	String. The baseline number/name should be URI encoded (js ex: encodeURIComponent())
Body		The property to save (Property { // Object of type Property type: { // Object of type PropertyType }, // Type of the property, a property can be INLINE (created in a page) or EXTERNAL, created in the RY pages Note: Legacy properties (before v3.0.0) are INLINE 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, // If false, the property is not displayed to the user. This is not saved, and it depends on the key starting with '_' dataType: { // Object of type PropertyDataType }, // The type when searching or performing aggregations. By default, it's a string, and values are displayed as HTML. 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. When reading a requirement, this is not guaranteed to be present. If missing, then indexation will be performed by extracting the text out of the 'value' of the property. propertyNameMeta: { // Object of type PropertyNameMeta dropdownItems: { // Object of type java.util.Map<java.lang.String,com.playsql.requirementyogi.api.beans.properties.MetaDropdownOption> }, }, // Property name meta information. It can be null if : - the external property does not require to have meta information (ex DROPDOWN requires it) - the entry point did not ask to fill this information (expand = propertyNameMeta) }
Returns		HTTP Response. RequirementKeyBean

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 IntegrationManager for version info.APIVersions#getAPIVersions() countMessagesInQueue: long, // Count of messages awaiting to be read. status: String, // DBApplink#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 IntegrationManager for version info.APIVersions#getAPIVersions() countMessagesInQueue: long, // Count of messages awaiting to be read. status: String, // DBApplink#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.
Query param	?timeout=...	Integer. the timeout in milliseconds, optional, the default is 30s, the max is 180s. Since 2.6.2 / APIv8.
Body		the list of JiraQueueMessage `[ { // Object of type JiraQueueMessage operation: String, title: String, templateId: Long, }, ... ]`
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: long, // 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: long, // 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

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

@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}/meta/{issueTypeId}

@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.
Path param	{issueTypeId}	long.
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: long, // 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, isPublicDescription: Boolean, }, ... ], 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.

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

@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.
Query param	?timeout=...	Long. the timeout, in milliseconds. If elapsed, we'll return at least 1 suggestion if possible. Default value is 2000 ms.
Body		`[ { // Object of type java.lang.String value: [ , ... ], coder: byte, hash: int, }, ... ]`
Returns		HTTP Response.

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

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

Delete a suggestion

Type	Name	Description
Path param	{spaceKey}	String.
Body		String. the unique key, as returned in the administration
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 "KEY 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

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

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

Same as GET /uiSearch but with a PUT when searchQuery is too long

Type	Name	Description
Path param	{spaceKey}	String.
Query param	?spaceKey=...	String.
Query param	?offset=...	Integer.
Query param	?limit=...	Integer.
Query param	?includeBaselined=...	boolean.
Query param	?includeArchived=...	boolean.
Query param	?baselineCondition=...	String.
Query param	?sort=...	String.
Query param	?order=...	String.
Body		`{ // Object of type MiscResource.SearchRequestBody q: String, // SearchQuery }`
Returns		HTTP Response.

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.

This method used to be used until commit 399a93d5395ad116, we're just keeping it for 2 years:
If some needs to migrate his queries urgently, we can tell them to POST on this URL.
To remove in October 2022.

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

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}

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

Returns a list of property used in the subMenu
Note: keeping list of Property (and not PropertyName) because the menu already uses requirement.getProperties to build the items.

Type	Name	Description
Path param	{spaceKey}	String. current spaceKey
Query param	?limit=...	Integer. max number of items in the list
Query param	?filterPropertyType=...	String.
Query param	?filterPropertyName=...	String. String to filter the property names
Returns		HTTP Response.

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

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

Creates a property name

It the property name already exists, returns a Bad Request.

Only users who can edit space or confluence administrators can create property names.

Type	Name	Description
Path param	{spaceKey}	String.
Body		Property containing the information { // Object of type PropertyName key: String, // The key, in UTF-8 dataType: { // Object of type PropertyDataType }, // The type when searching or performing aggregations. By default, it's a string, and values are displayed as HTML. meta: { // Object of type PropertyNameMeta dropdownItems: { // Object of type java.util.Map<java.lang.String,com.playsql.requirementyogi.api.beans.properties.MetaDropdownOption> }, }, // A property name can have more information depending on the dataType. Example, a dropdown list limits the possible values a Property can have. meta contains the list of possible values. }
Returns		HTTP Response.

PUT /rest/reqs/1/propertynames/{spaceKey}/{propertyName}

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

Updates property name.
Only Confluence administrators can do that, because it doesn't update the traceability matrixes,
the saved reports, saved searches, etc.
At the time of writing, it only updates the type and metadata of the PropertyName.

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{propertyName}	String.
Body		Property containing the information { // Object of type PropertyName key: String, // The key, in UTF-8 dataType: { // Object of type PropertyDataType }, // The type when searching or performing aggregations. By default, it's a string, and values are displayed as HTML. meta: { // Object of type PropertyNameMeta dropdownItems: { // Object of type java.util.Map<java.lang.String,com.playsql.requirementyogi.api.beans.properties.MetaDropdownOption> }, }, // A property name can have more information depending on the dataType. Example, a dropdown list limits the possible values a Property can have. meta contains the list of possible values. }
Returns		HTTP Response.

DELETE /rest/reqs/1/propertynames/{propertyName}

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

Deletes a property name
Only Confluence administrators can do that (see: null spacekey)

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

RYSettingsResource

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.

List preloaded keys

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.

Save the settings.
Requires admin permissions on the space or application.

Type	Name	Description
Path param	{settingsName}	String. the name of the setting, one of RYSettingKey
Query param	?spaceKey=...	String. optional, the space key for space-level settings, or null for global settings
Body		String. the value of the settings, true/false for booleans.
Returns		Object.

PUT /rest/reqs/1/settings

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

Save the settings.
Requires admin permissions on the space or application.

Type	Name	Description
Query param	?spaceKey=...	String. optional, the space key for space-level settings, or null for global settings
Body		a map of values `{ // Object of type java.util.Map<java.lang.String,java.lang.String> }`
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.

PUT /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 moves the links from one issue to another.
Requires space-admin permissions

Type	Name	Description
Query param	?applink=...	String. String
Query param	?issue=...	String. String, the old Jira issue key.
Query param	?newIssue=...	String. String, the new Jira issue key.
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.

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.
Query param	?timeout=...	Long. the timeout in milliseconds. Optional, default is 3.5s.
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	?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. The content-id of the current page
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	?flushJiraCache=...	boolean.
Query param	?crossSpace=...	boolean.
Query param	?columnsJson=...	String. A Json representation of the matrix columns to render, required
Query param	?ceoId=...	String. The content-id of the current page
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.
Called when widget.ajaxReload

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	?flushJiraCache=...	boolean.
Query param	?crossSpace=...	boolean.
Query param	?matrixType=...	String.
Body		`{ // Object of type TraceabilityResource.TraceabilityUIRenderRequest traceabilityMatrixColumns: String, offsetJson: String, variables: { // Object of type java.util.Map<java.lang.String,java.lang.Object> }, }`
Returns		HTTP Response.

PUT /rest/reqs/1/traceability/{spaceKey}/uiTraceability/column/{columnNumber}/frontEndData

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

A REST resource to return the front-end data of a column.

It will deduplicate results.

It will take care of not loading the entire columns, just the ones "parent" of the requested one.

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{columnNumber}	int.
Query param	?q=...	String.
Query param	?limit=...	Integer.
Query param	?includeBaselined=...	boolean.
Query param	?includeArchived=...	boolean.
Query param	?withJira=...	boolean.
Query param	?flushJiraCache=...	boolean.
Query param	?crossSpace=...	boolean.
Query param	?matrixType=...	String.
Body		`{ // Object of type TraceabilityResource.TraceabilityUIRenderRequest traceabilityMatrixColumns: String, offsetJson: String, variables: { // Object of type java.util.Map<java.lang.String,java.lang.Object> }, }`
Returns		HTTP Response.

GET /rest/reqs/1/traceability/{spaceKey}/uiTraceability/customfields/{applink}

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

Get the list of custom fields in the Jira instance.

Type	Name	Description
Path param	{spaceKey}	String.
Path param	{applink}	String.
Query param	?fields=...	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

AccumulatorResource

BaselineActionsResource

ExcelResource

ExternalPropertyResource

HelpersResource

IntegrationResource

IssueTemplatesResource

JiraResources

KeySuggestionResource

LongRunningTaskResource

MiscResource

OnboardingResource

PersonalQueueResource

PropertyNameResource

RYSettingsResource

RepairResource

RteResource

TraceabilityResource

TypesResource

UninstallResource