@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.
Displays generic information about this REST resource.Type | Name | Description |
---|---|---|
Query param | ?url=... | String. |
Query param | ?applinkId=... | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
This is the RY API v1-to-now, the one that is standard between all external apps around RY.Type | Name | Description |
---|---|---|
Query param | ?url=... | String. |
Query param | ?applinkId=... | String. |
Query param | ?timeout=... | Long. the timeout in milliseconds, minimum 3 seconds, and default is 40s |
Query param | ?bypassLock=... | boolean. false by default. True if you want to bypass the lock, notably if the queue is being sent by the administrator. |
Body |
[ { // Object of type MessageFromConfluence
id: Long, // ID of the message, so we can send an appropriate answer
relationship: String,
authorKey: String, // The author's userKey in Confluence.
|
|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {applinkId} | String. |
Body | String. | |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Updates the API to the provided version.@since RY-395 in RY 2.2.1 (API v3)
Type | Name | Description |
---|---|---|
Query param | ?url=... | String. |
Query param | ?applinkId=... | String. |
Body | String. the maximum supported version on the Confluence side | |
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 |
---|---|---|
Query param | ?relationship=... | String. |
Query param | ?applink=... | String. |
Query param | ?spaceKey=... | String. |
Query param | ?reqKey=... | String. |
Query param | ?v=... | Long. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
List issue links.Type | Name | Description |
---|---|---|
Path param | {issueKey} | String. |
Query param | ?relationship=... | String. |
Query param | ?fixBrokenLinks=... |
boolean.
boolean, Whether to fix broken links or not. This argument was introduced in the version 2.6.5 (API V9), to fix broken links and help RY Confluence move links of moved issues to new issues. If the customer is using RY (Confluence) version <= 2.6.4, he will not be able to move the links of the moved issue to the new one. |
Returns | HTTP Response. the list of requirements (may be empty); 404 if the issue is not found or if the user doesn't have permissions. |
@Internal Private resource. It will change often and it is not entirely documented.
Create one or several linksType | Name | Description |
---|---|---|
Path param | {issueKey} | String. the issue key |
Body |
list of Requirement with properties: applinkId, spaceKey, key, baselineNumber.
[ { // Object of type Requirement
applinkId: String, // The applink ID. It will be used to update the
|
|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Reset all the links, either for a single relationship, either for all links of the issue.Type | Name | Description |
---|---|---|
Path param | {issueKey} | String. the issue key |
Query param | ?relationship=... | String. the relationship. If empty, all the links of the issue will be used. |
Body |
list of Requirement with all their properties
[ { // Object of type Requirement
applinkId: String, // The applink ID. It will be used to update the
|
|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Remove the links.Type | Name | Description |
---|---|---|
Path param | {issueKey} | String. the issue key |
Body |
list of Requirement with properties: applinkId, spaceKey, key, baselineNumber, relationship.
[ { // Object of type Requirement
applinkId: String, // The applink ID. It will be used to update the
|
|
Returns | HTTP Response. |
The search resource for requirements
@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.
Clear the cache of baselines for the projectType | Name | Description |
---|---|---|
Path param | {project} | String. project key |
Returns | HTTP Response. a text answer. |
@Internal Private resource. It will change often and it is not entirely documented.
Search for the space and baselines according to "q".@since 2.6.3 for the Criteria-and-baselines JS object
Type | Name | Description |
---|---|---|
Path param | {projectKey} | String. |
Query param | ?q=... | String. the search query |
Query param | ?insist=... |
boolean.
by default (false), we only search among baseline names for the linked spaces. If insist=true, we also search for all spaces, and all baseline names. |
Query param | ?limit=... | Integer. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
We save the last baseline searched by the userType | Name | Description |
---|---|---|
Query param | ?projectKey=... | String. |
Body | String. | |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Called by Confluence.
This is a redirect to /operations/rename
@deprecated Please use {@link OperationsResource#rename} since 2.2.0/RY-395
Type | Name | Description |
---|---|---|
Query param | ?url=... | String. the baseurl of Confluence |
Body |
a list of RequirementRenameData
[ { // Object of type AbstractResourceWithOperations.RequirementRenameData
oldKey: String,
spaceKey: String,
version: Integer,
newKey: String,
newSpaceKey: String,
newVersion: Integer,
issueKey: String,
relationship: String,
}, ... ]
|
|
Returns | HTTP Response. Always 200, with a list of error messages. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {issueNumber} | Long. |
Query param | ?from=... | Long. |
Query param | ?to=... | Long. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Creation of links in mass, for the provided issue.
This is a redirect to /operations/createRIL.
@deprecated Please use {@link OperationsResource#createRIL} since 2.2.0/RY-395
Type | Name | Description |
---|---|---|
Query param | ?url=... | String. |
Body |
{ // Object of type AbstractResourceWithOperations.RILCreationPayload
links: [ { // Object of type RequirementToJiraLink
spaceKey: String,
reqKey: String,
version: Integer,
jiraData: [ { // Object of type RequirementToJiraLink.Issue
applink: String,
issueKey: String,
relationship: String,
summary: String,
}, ... ],
}, ... ],
relationships: [ { // 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.
Get relationshipsType | Name | Description |
---|---|---|
Query param | ?projectKey=... | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Return suggestions for a given requirement that has lost its key (see https://playsql.atlassian.net/browse/RY-511)Type | Name | Description |
---|---|---|
Query param | ?id=... | long. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
This function returns a requirement from Confluence.Type | Name | Description |
---|---|---|
Query param | ?applinkId=... | String. |
Query param | ?spaceKey=... | String. |
Query param | ?key=... | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
This function reassigns a key to a requirement that has a NULL key.Type | Name | Description |
---|---|---|
Path param | {id} | long. |
Query param | ?spaceKey=... | String. |
Query param | ?key=... | String. |
Returns | HTTP Response. |
A resource to retrieve the metadata for Requirement Yogi, such as the list of custom fields
@Internal Private resource. It will change often and it is not entirely documented.
@Internal Private resource. It will change often and it is not entirely documented.
Replaces http://jira.local:2990/jira/rest/api/2/field because it is too slow on larger instancesType | Name | Description |
---|---|---|
Query param | ?fields=... | String. comma-separated list of field IDs (customfield_10000,...) to include |
Query param | ?types=... | String. comma-separated list of field types (schema.custom value in /rest/api/2/field) to include |
Returns | HTTP Response. |
In this class, we'll progressively move all operations, such as /rename and /createRIL.
@since 2.2 and the implementation of RY-395 (the big Jira refactor)
@Internal Private resource. It will change often and it is not entirely documented.
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Creation of links in mass, for the provided issueType | Name | Description |
---|---|---|
Path param | {applinkId} | String. |
Body |
{ // Object of type AbstractResourceWithOperations.RILCreationPayload
links: [ { // Object of type RequirementToJiraLink
spaceKey: String,
reqKey: String,
version: Integer,
jiraData: [ { // Object of type RequirementToJiraLink.Issue
applink: String,
issueKey: String,
relationship: String,
summary: String,
}, ... ],
}, ... ],
relationships: [ { // 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.
Called by Confluence.Type | Name | Description |
---|---|---|
Path param | {applinkId} | String. |
Body |
a list of RequirementRenameData
[ { // Object of type AbstractResourceWithOperations.RequirementRenameData
oldKey: String,
spaceKey: String,
version: Integer,
newKey: String,
newSpaceKey: String,
newVersion: Integer,
issueKey: String,
relationship: String,
}, ... ]
|
|
Returns | HTTP Response. Always 200, with a list of error messages. |
@Internal Private resource. It will change often and it is not entirely documented.
Create or update issues in bulk@since APIv5 and version 2.3.
Type | Name | Description |
---|---|---|
Path param | {applinkId} | String. The application link. |
Path param | {projectId} | long. The project id. |
Query param | ?url=... | String. Confluence url. |
Query param | ?issueTemplateId=... | long. |
Body |
List of JiraConfluenceSharedBeans.IssueRequest
[ { // Object of type JiraConfluenceSharedBeans.IssueRequest
requirements: [ { // Object of type JiraConfluenceSharedBeans.Requirement
key: String,
spaceKey: String,
baseline: Integer,
htmlExcerpt: String,
relationship: String,
}, ... ],
issueFields: [ { // Object of type JiraConfluenceSharedBeans.IssueField
fieldName: String,
value: String,
values: [ { // Object of type java.lang.String
value: [ , ... ],
coder: byte,
hash: int,
}, ... ],
}, ... ],
issueKey: String,
createNew: boolean,
}, ... ]
|
|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path 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 | {applinkId} | String. |
Path param | {jobId} | long. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {jobId} | long. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {jobId} | long. |
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 | {applinkId} | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Send queue messages to an instance of Confluence.Type | Name | Description |
---|---|---|
Path param | {applinkId} | String. Confluence's application link id |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Delete QueueMessages.Type | Name | Description |
---|---|---|
Path param | {applinkId} | String. Confluence application link id. |
Query param | ?status=... |
Message status to delete.
{ // Object of type DBQueueMessage.Status
}
|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Send one QueueMessage if the user has permissions.Type | Name | Description |
---|---|---|
Path param | {applinkId} | String. Confluence application link id. |
Path param | {messageId} | long. QueueMessage id. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Delete one QueueMessage if the user has permissions.Type | Name | Description |
---|---|---|
Path param | {applinkId} | String. Confluence application link id. |
Path param | {messageId} | long. QueueMessage id. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {applinkId} | String. |
Body | String. | |
Returns | HTTP Response. |
A resource to search for requirements in Confluence.
@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.
Search for requirements across all applinked Confluence instances.Type | Name | Description |
---|---|---|
Query param | ?q=... | String. full-string query |
Query param | ?project=... |
String.
the current project key, optional, to restrict the query to Confluence instances and spaces which are linked with this Jira project |
Query param | ?spaceKey=... | String. the space key, comma-separated list |
Query param | ?baselineCondition=... | String. |
Returns | HTTP Response. a SearchResults instance |
@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.
Attempts to authenticat the user to Confluence.Type | Name | Description |
---|---|---|
Path param | {serviceId} | String. |
Body | String. | |
Returns |
HTTP Response.
an AuthenticationResponse containing the success/error messages, or a BAD_REQUEST/FORBIDDEN if Confluence wasn't even reached. |
@Internal Private resource. It will change often and it is not entirely documented.
Attempts to set the remote username for the connectionType | Name | Description |
---|---|---|
Path param | {serviceId} | String. |
Body | String. | |
Returns |
HTTP Response.
an AuthenticationResponse containing the success/error messages, or a BAD_REQUEST/FORBIDDEN if Confluence wasn't even reached. |
Resource to manage the job that resynchronizes a set of issues with Confluence.
@Internal Private resource. It will change often and it is not entirely documented.
@Internal Private resource. It will change often and it is not entirely documented.
Not public. Creates demo data to test the Remote Issue Link migration.Type | Name | Description |
---|---|---|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not public. Creates demo data to test the Remote Issue Link migration.Type | Name | Description |
---|---|---|
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Query param | ?issues=... | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Resynchronizes the issue keys with Confluence:
Type | Name | Description |
---|---|---|
Query param | ?issues=... | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Not publicType | Name | Description |
---|---|---|
Path param | {jobId} | String. |
Returns | HTTP Response. |
@Internal Private resource. It will change often and it is not entirely documented.
Upgrade the requirements in a baseline.Type | Name | Description |
---|---|---|
Query param | ?issue=... | String. |
Body | String. a map of RYGlobalId -> Requirement. | |
Returns | HTTP Response. a json of the list of updated requirements and errors |