@PublicApi This API is public. See our policy.
@PublicApi This API is public. See our policy.
@PublicAPI
– Read our API policy
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. |
@Internal Private resource. It will change often and it is not entirely documented.
List the baselines in this space.Type | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Path param | {version} | int. |
Returns | HTTP Response. a list of pages. |
@Internal Private resource. It will change often and it is not entirely documented.
Freeze a baseline, based on a query.
API subject to change in micro releases.
Type | Name | Description |
---|---|---|
Path param | {spaceKey} | String. the space key |
Body |
JSON containing:
{ // Object of type CreationPayloadClassic
queryString: String,
name: String,
ceo: String,
}
|
|
Returns | HTTP Response. the details of the baseline, in JSON. |
@Internal Private resource. It will change often and it is not entirely documented.
Freeze a baseline, based on a query.
API subject to change in micro releases.
Type | Name | Description |
---|---|---|
Path param | {spaceKey} | String. the space key |
Body |
JSON containing:
{ // Object of type CreationPayloadInstant
name: String,
fromCeo: Long,
fromCeoWithChildren: boolean,
}
|
|
Returns | HTTP Response. the details of the baseline, in JSON. |
@PublicApi This API is public. See our policy.
Not documentedType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Path param | {version} | int. |
Body | String. | |
Returns | HTTP Response. |
@PublicApi This API is public. See our policy.
Not documentedType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Path param | {version} | int. |
Returns | HTTP Response. |
@PublicApi This API is public. See our policy.
Verifies the validity of the name for the next baselineType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Query param | ?baselineName=... | String. |
Returns | HTTP Response. |
@PublicApi This API is public. See our policy.
Suggest the name for the next baselineType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Query param | ?pageName=... | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Used to refreeze a baseline and create a new page for it. It executes a longRunningTask that will do this operation.Type | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Body |
{ // Object of type RefreezePayload
baselineNumberToRefreeze: int,
requirements: [ { // Object of type RequirementRef
relationship: String, // The user's name on the relationship
spaceKey: String, // The requirement's space
key: String, // The requirement key
baseline: Integer, // The requirement baseline
url: String,
}, ... ],
title: String,
}
|
|
Returns | HTTP Response. |
CRUD API for requirements. As opposed to RequirementResource, this one is space-local.
@PublicApi This API is public. See our policy.
@Internal Private resource. It will change often and it is not entirely documented.
@InternalAPI – Not intended for use by customers
Adds or removes a link between a requirement and a Jira issue.@deprecated since 2.2 and RY-395, we've replaced with posting to /queue/inbound
Type | Name | Description |
---|---|---|
Path param | {key} | String. the requirement key |
Path param | {spaceKey} | String. the space key |
Path param | {issue} | String. the Jira issue key |
Query param | ?baseline=... | Integer. |
Query param | ?jiraUrl=... | String. the Jira url. Only the Applink ID is saved in the requirement link. |
Query param | ?relationship=... | String. |
Body |
the title of the issue.
{ // Object of type RequirementResource2.IssueLinkDetails
title: String,
relationship: String,
}
|
|
Returns | HTTP Response. 201-CREATED |
@Internal Private resource. It will change often and it is not entirely documented.
@InternalAPI – Not intended for use by customers
Adds or removes a link between a requirement and a Jira issue.@deprecated since 2.2 and RY-395, we've replaced with posting to /queue/inbound
Type | Name | Description |
---|---|---|
Path param | {key} | String. the requirement key |
Path param | {spaceKey} | String. the space key |
Path param | {issue} | String. the Jira issue key |
Query param | ?baseline=... | Integer. |
Query param | ?relationship=... | String. |
Query param | ?jiraUrl=... | String. the Jira url. Only the Applink ID is saved in the requirement link. |
Returns | HTTP Response. 204-NO_CONTENT |
@PublicApi This API is public. See our policy.
@PublicAPI – Read our API policy
Get a requirementType | 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. |
@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 |
Query param | ?spaceKey=... |
String.
Comma-separated list, or "*" to ignore spaces. Restricts the search to this specific space. If null, and if the option "isolate spaces" is ticked, then it is defaulted to the current space. |
Query param | ?offset=... | Integer. Used for pagination |
Query param | ?includeArchived=... |
boolean.
Whether the archived requirements should be included. By default (false), only current (ACTIVE) requirements are displayed, unless there is a reason not to (such as a baselineCondition). |
Query param | ?baselineCondition=... |
String.
Restrict the search to these specific baselines. Example: "ds-1,ie-8" signifies "The baseline 1 of space 'ds' or the baseline 8 of space 'ie'". |
Query param | ?limit=... | Integer. Used for pagination |
Query param | ?sort=... | String. The SQL ORDER BY clause, by default "REQKEY ASC, BASELINE DESC" |
Query param | ?order=... | String. Do not use. |
Query param | ?suggest=... | Integer. |
Returns | HTTP Response. |
@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.Type | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Path param | {key} | String. |
Query param | ?mode=... | String. |
Query param | ?suggestPrefix=... | String. |
Query param | ?suggestStart=... | Integer. |
Query param | ?suggestPadding=... | Integer. |
Query param | ?suggestQuantity=... | Integer. |
Query param | ?provided=... |
String.
list of requirements to create. It was removed in 2.5.1. Before that, it was a comma-separated list of keys. |
Query param | ?providedJson=... |
String.
a JSON list of requirements to create. It was created in 2.5.1 to replace 'provided', since we now accept commas in requirement keys. |
Query param | ?override=... | boolean. |
Query param | ?pageId=... | Long. |
Body |
{ // Object of type Requirement
id: int,
key: String,
spaceKey: String,
baseline: Integer, // The baseline of the requirement. It's either the actual baseline, or the latest baseline number of the space.
baselineDetails: { // Object of type Baseline
baseline: Integer,
spaceKey: String,
name: String,
pageId: Long, // Optional. The page where the release is described.
count: Integer, // Optional. The number of requirements in this baseline.
pageCount: Integer, // Optional. The number of pages frozen by this baseline.
pageUrl: String, // Optional. The url of the page where the release is described, omitting the contextPath.
indexUrl: String, // The url of the list-baselines.action page, omitting the contextPath.
canonicalUrl: String, // The url of the page, or, by default, the indexUrl
},
newSpaceKey: String,
status: String,
htmlExcerpt: String,
htmlNeedsUpdating: boolean,
page: { // Object of type PageRef
pageId: Long,
version: Long, // The version of the page. This is useful when a link points to an older version of a page.
|
|
Returns | HTTP Response. |
@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. |
@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 descriptionType | Name | Description |
---|---|---|
Path param | {key} | String. |
Path param | {spaceKey} | String. |
Body |
{ // Object of type Requirement
id: int,
key: String,
spaceKey: String,
baseline: Integer, // The baseline of the requirement. It's either the actual baseline, or the latest baseline number of the space.
baselineDetails: { // Object of type Baseline
baseline: Integer,
spaceKey: String,
name: String,
pageId: Long, // Optional. The page where the release is described.
count: Integer, // Optional. The number of requirements in this baseline.
pageCount: Integer, // Optional. The number of pages frozen by this baseline.
pageUrl: String, // Optional. The url of the page where the release is described, omitting the contextPath.
indexUrl: String, // The url of the list-baselines.action page, omitting the contextPath.
canonicalUrl: String, // The url of the page, or, by default, the indexUrl
},
newSpaceKey: String,
status: String,
htmlExcerpt: String,
htmlNeedsUpdating: boolean,
page: { // Object of type PageRef
pageId: Long,
version: Long, // The version of the page. This is useful when a link points to an older version of a page.
|
|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
@InternalAPI – Not intended for use by customers
Type | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Body |
[ { // Object of type Requirement
id: int,
key: String,
spaceKey: String,
baseline: Integer, // The baseline of the requirement. It's either the actual baseline, or the latest baseline number of the space.
baselineDetails: { // Object of type Baseline
baseline: Integer,
spaceKey: String,
name: String,
pageId: Long, // Optional. The page where the release is described.
count: Integer, // Optional. The number of requirements in this baseline.
pageCount: Integer, // Optional. The number of pages frozen by this baseline.
pageUrl: String, // Optional. The url of the page where the release is described, omitting the contextPath.
indexUrl: String, // The url of the list-baselines.action page, omitting the contextPath.
canonicalUrl: String, // The url of the page, or, by default, the indexUrl
},
newSpaceKey: String,
status: String,
htmlExcerpt: String,
htmlNeedsUpdating: boolean,
page: { // Object of type PageRef
pageId: Long,
version: Long, // The version of the page. This is useful when a link points to an older version of a page.
|
|
Returns | HTTP Response. |
A Requirement resource that returns requirements in bulk
@PublicApi This API is public. See our policy.
@Internal Private resource. It will change often and it is not entirely documented.
Returns the list of requirements that match the requests.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. |
REST endpoint to handle files for excel Integration
@Internal Private resource. It will change often and it is not entirely documented.
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Path param | {attachmentId} | Long. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Path param | {attachmentId} | Long. |
Body |
{ // Object of type WorkbookConfig.IntegrationState
}
|
|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Path param | {attachmentId} | Long. |
Returns | HTTP Response. |
Various functions that didn't fit in other resources
@Internal Private resource. It will change often and it is not entirely documented.
@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. |
A REST resource to integrate RY with any other software.
@Internal Private resource. It will change often and it is not entirely documented.
@Internal Private resource. It will change often and it is not entirely documented.
Returns the list of connected applicationsType | 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. |
@Internal Private resource. It will change often and it is not entirely documented.
Add an integrationType | 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
|
|
Returns | HTTP Response. the IntegrationDescriptor |
@Internal Private resource. It will change often and it is not entirely documented.
Get the details of an integration.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 |
@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.Type | Name | Description |
---|---|---|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | 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. |
@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.Type | Name | Description |
---|---|---|
Path param | {serviceId} | String. |
Query param | ?version=... | Integer. |
Query param | ?status=... | String. |
Returns | HTTP Response. |
@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
|
|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Delete the descriptorType | Name | Description |
---|---|---|
Path param | {serviceId} | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Gets the elements of the queue.Type | Name | Description |
---|---|---|
Path param | {serviceId} | String. |
Query param | ?limit=... | Integer. |
Query param | ?includeDone=... | boolean. |
Query param | ?includeLastResponse=... | boolean. |
Returns | HTTP Response. |
@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. |
@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. |
@Internal Private resource. It will change often and it is not entirely documented.
Attempts to flush the queueType | Name | Description |
---|---|---|
Path param | {serviceId} | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Accept messages about the integration, to remove/reset/add links.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 |
@Internal Private resource. It will change often and it is not entirely documented.
Accept messages about the integration, to remove/reset/add links.Type | Name | Description |
---|---|---|
Path param | {serviceId} | String. the service that's integrating |
Query param | ?url=... |
String.
if the service is null, please provide the base URL of the application and we'll try to match. |
Body |
the list of InboundQueueMessage
[ { // Object of type QueueMessage.InboundQueueMessage
operation: String, // The operation.InEvent
title: String, // Title of the remote object (Optional)
templateId: Integer,
}, ... ]
|
|
Returns | HTTP Response. a list of Answer |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {serviceId} | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
@Internal Private resource. It will change often and it is not entirely documented.
Return templates for a given spaceKeyType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Body |
{ // Object of type IssueTemplate
id: int, // Active Object generated ID
spaceKey: String,
title: String,
applinkId: String,
projectId: long,
issueTypeId: long,
relationship: String,
fields: String,
groupAll: boolean,
projectMetadata: String, // Stringify Json: {
|
|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Path param | {id} | int. |
Body |
{ // Object of type IssueTemplate
id: int, // Active Object generated ID
spaceKey: String,
title: String,
applinkId: String,
projectId: long,
issueTypeId: long,
relationship: String,
fields: String,
groupAll: boolean,
projectMetadata: String, // Stringify Json: {
|
|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Path param | {id} | int. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Path param | {id} | int. |
Query param | ?offset=... | int. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {serviceId} | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {serviceId} | String. |
Path param | {projectKey} | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {serviceId} | String. |
Path param | {projectKey} | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {serviceId} | String. |
Body |
{ // Object of type IssuesCreationRequestFromUI
issueTemplate: { // Object of type IssueTemplate
id: int, // Active Object generated ID
spaceKey: String,
title: String,
applinkId: String,
projectId: long,
issueTypeId: long,
relationship: String,
fields: String,
groupAll: boolean,
projectMetadata: String, // Stringify Json: {
|
|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Fetches the status of Jira issues. Permissions are those of JiraType | Name | Description |
---|---|---|
Path param | {serviceId} | String. the applink ID |
Query param | ?issues=... | String. the list of issue keys, comma-separated |
Returns | HTTP Response. |
@deprecated since 1.10.1 (January 2018) - Do not use
@Internal Private resource. It will change often and it is not entirely documented.
@Internal Private resource. It will change often and it is not entirely documented.
@deprecated since 1.10.1 (January 2018) - This method only works for Jira, since it only filters TYPE_JIRA
Type | Name | Description |
---|---|---|
Query param | ?from=... | String. |
Body | String. | |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {taskId} | String. |
Returns | HTTP Response. |
@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.Type | Name | Description |
---|---|---|
Query param | ?applinkId=... | String. |
Returns | HTTP Response. |
@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.Type | Name | Description |
---|---|---|
Path param | {jobId} | int. |
Query param | ?applinkId=... | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Abort a job, assuming the current user has permissions.Type | Name | Description |
---|---|---|
Path param | {jobId} | int. |
Query param | ?applinkId=... | String. |
Returns | HTTP Response. |
@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. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | 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. |
@Internal Private resource. It will change often and it is not entirely documented.
Aborts the task and stop its trackingType | Name | Description |
---|---|---|
Path param | {taskId} | String. |
Returns | HTTP Response. |
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.
@Internal Private resource. It will change often and it is not entirely documented.
Returns the history of a requirement.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. |
@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 |
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 | ?includeArchived=... |
boolean.
Whether the archived requirements should be included. By default (false), only current (ACTIVE) requirements are displayed, unless there is a reason not to (such as a baselineCondition). |
Query param | ?baselineCondition=... | String. Restrict the search to these specific baselines. |
Query param | ?sort=... | String. The SQL ORDER BY clause, by default "REQKEY ASC, BASELINE DESC" |
Query param | ?order=... | String. Do not use. |
Returns | HTTP Response. a RequirementSearchResult that contains => the search result, the suggestion filter, permissions, and whether the plugin RYTest is active |
@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. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
A REST resource to help the UI of the traceability matrix.Type | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Query param | ?q=... | String. |
Query param | ?limit=... | Integer. |
Query param | ?includeArchived=... | boolean. |
Query param | ?withJira=... | boolean. |
Body |
{ // Object of type MiscResource.TraceabilityUIRenderRequest
traceabilityMatrixColumns: String,
offsetJson: String,
}
|
|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Path param | {id} | int. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
For test purposesType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Query param | ?query=... | String. the query string, for example "key~'REQ-10%'" |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Returns a MultiMap (key: relationship, values: requirementRef) to show the dependencies that should be added to the new baseline if we are refreezingType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Query param | ?requirementQuery=... | String. |
Returns | HTTP Response. |
@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. |
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.
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {settingsName} | String. |
Body | String. | |
Returns | Object. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Query param | ?sendeveryone=... | boolean. |
Returns | Object. |
Deprecated. Use /requirement2 instead.RequirementResource2
@Internal Private resource. It will change often and it is not entirely documented.
@Internal Private resource. It will change often and it is not entirely documented.
@deprecated use /requirement2/{spaceKey}
Type | Name | Description |
---|---|---|
Path param | {key} | String. |
Query param | ?expand=... | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
@deprecated use /requirement2/{spaceKey}
Type | Name | Description |
---|---|---|
Path param | {key} | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
This is the key place where we write the requirement description@deprecated use /requirement2/{spaceKey}
Type | Name | Description |
---|---|---|
Path param | {key} | String. |
Body |
{ // Object of type Requirement
id: int,
key: String,
spaceKey: String,
baseline: Integer, // The baseline of the requirement. It's either the actual baseline, or the latest baseline number of the space.
baselineDetails: { // Object of type Baseline
baseline: Integer,
spaceKey: String,
name: String,
pageId: Long, // Optional. The page where the release is described.
count: Integer, // Optional. The number of requirements in this baseline.
pageCount: Integer, // Optional. The number of pages frozen by this baseline.
pageUrl: String, // Optional. The url of the page where the release is described, omitting the contextPath.
indexUrl: String, // The url of the list-baselines.action page, omitting the contextPath.
canonicalUrl: String, // The url of the page, or, by default, the indexUrl
},
newSpaceKey: String,
status: String,
htmlExcerpt: String,
htmlNeedsUpdating: boolean,
page: { // Object of type PageRef
pageId: Long,
version: Long, // The version of the page. This is useful when a link points to an older version of a page.
|
|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Body |
[ { // Object of type Requirement
id: int,
key: String,
spaceKey: String,
baseline: Integer, // The baseline of the requirement. It's either the actual baseline, or the latest baseline number of the space.
baselineDetails: { // Object of type Baseline
baseline: Integer,
spaceKey: String,
name: String,
pageId: Long, // Optional. The page where the release is described.
count: Integer, // Optional. The number of requirements in this baseline.
pageCount: Integer, // Optional. The number of pages frozen by this baseline.
pageUrl: String, // Optional. The url of the page where the release is described, omitting the contextPath.
indexUrl: String, // The url of the list-baselines.action page, omitting the contextPath.
canonicalUrl: String, // The url of the page, or, by default, the indexUrl
},
newSpaceKey: String,
status: String,
htmlExcerpt: String,
htmlNeedsUpdating: boolean,
page: { // Object of type PageRef
pageId: Long,
version: Long, // The version of the page. This is useful when a link points to an older version of a page.
|
|
Returns | HTTP Response. |
A resource for anything managed in the Rich Text Editor
@Internal Private resource. It will change often and it is not entirely documented.
@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.Type | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Body |
[ { // Object of type java.lang.String
value: [ , ... ],
coder: byte,
hash: int,
}, ... ]
|
|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
@InternalAPI – Read our API policy
Both search for requirements and provide suggestions for keys. This resource is only used in the RTE.Type | Name | Description |
---|---|---|
Path param | {spaceKey} |
String.
the space key in the URL path. If the option "Isolate Spaces" is ticked in the administration, then the search is restricted to this space. Can be "*". |
Query param | ?q=... |
String.
the text entered by the user. This is NOT using the "Search Syntax". We'll return the keys matching exactly this text first, then the keys starting with this text, then requirements containing this text. |
Query param | ?includeArchived=... |
boolean.
Whether the archived requirements should be included. By default (false), only current (ACTIVE) requirements are displayed, unless there is a reason not to (such as a baselineCondition). |
Query param | ?suggest=... |
Integer.
The number of suggestions that can be returned for keys. Default is 0. If > 0, it will take the requirements returned by the search for this space, add 1 until we find one that doesn't exist. It is quite expensive in terms of resources, so please do not use lightly. |
Returns | HTTP Response. |
@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 | ?displayMode=... | String. String, possible values: "results_only, search_only, search_and_results", required |
Query param | ?columns=... | String. Comma-separated list of columns to render, optional by default the result report will contain three columns: key, description, links |
Query param | ?sameSpace=... | boolean. A Boolean to determine if we search cross space or not |
Returns | HTTP Response. |
@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 | ?columnsJson=... | String. A Json representation of the matrix columns to render, required |
Returns | HTTP Response. |
CRUD API for settings.
@Internal Private resource. It will change often and it is not entirely documented.
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Returns | Object. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {settingsName} | String. |
Returns | Object. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {settingsName} | String. |
Body | String. | |
Returns | Object. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Body |
{ // Object of type java.util.Map<java.lang.String,java.lang.String>
}
|
|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
@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.Type | Name | Description |
---|---|---|
Path param | {spaceKey} | String. the space key |
Query param | ?refresh=... | boolean. |
Returns | HTTP Response. the list |
@Internal Private resource. It will change often and it is not entirely documented.
Create a requirement/several requirements with the details provided in ReplacementRequest, thenType | 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. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {spaceKey} | String. |
Body |
{ // Object of type TypeResourceCreationRequest
reqKey: String,
typeName: String,
ceoId: Long,
description: String,
formatting: String,
}
|
|
Returns | HTTP Response. |