Page History
The Xray REST API provides the following endpoints for managing the Test Repository information of a given project.
Some endpoints support pagination, using the page
and limit
query parameters.
Hierarchy
- To obtain a list of all Test Repository folders of a given project, including their hierarchy information, you need to specify the key of the respective project.
Expand | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
|
...
- To obtain a list of the Tests associated with the Test Repository of a given project, you need to specify the key of project
- To obtain a list of the Tests contained within a given Test Repository folder, you need to specify its folderId, besides the project key
- To change (add/remove) Tests to a given folder, you need to specify the key of the respective project
Expand | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||
|
FOLDERS XXXXXXXX
- To view the Tests associated with a Test Execution, you need to specify the key of the Test Execution you want to view.
- To associate or remove a Test from a Test Execution, you need to send a JSON with a list of the keys. When associating, these keys can be Test keys or Test Set keys; when removing, they have to be Test keys.
- To remove a Test from a Test Execution, you need to specify the key of the Test you wish to remove.
Expand | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||
| ||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||
| ||||||||||||||||||||||||||
Responses 200 OK : text/plain : Successful. Returns a JSON objectReturn error messages, if there are any.
400 BAD_REQUEST : text/plain : Returns the error. 401 UNAUTHORIZED : text/plain : The Xray for JIRA license is not valid. 500 INTERNAL SERVER ERROR : text/plain : An internal error occurred getting the folder.An internal error occurred associating the tests. |
Folders
- To obtain or update information about a given Test Repository folder, you need to specify both the project key and the internal folder Id
- To remove a folder from the Test Repository, you need to specify both the project key and the internal folder Id
Expand | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
Responses200 OK : textapplication/plainjson : Successful. Returns a JSON object.
400 BAD_REQUEST : text/plain : Returns the error. 401 UNAUTHORIZED : text/plain : The Xray for JIRA license is not valid. 500 INTERNAL SERVER ERROR : text/plain : An internal error occurred getting the folder. |
Expand | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
Responses204 No content : text/plain : Successful. Does not return anything. 400 BAD_REQUEST : text/plain : Returns the error. 401 UNAUTHORIZED : text/plain : The Xray for JIRA license is not valid. 500 INTERNAL SERVER ERROR : text/plain : An internal error occurred associating getting the testsfolder. |
Expand | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||
|