Page History
Settings
Some settings can be exported using the REST API.
This page provides a list of the available endpoints available for managing Xray related settings.
Table of Contents | ||
---|---|---|
|
Test Statuses
To obtain a list of all Test (Run) Statuses, including the default ones
...
,
...
you just need to
...
invoke the following endpoint.
Expand | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
|
Test Step Statuses
To obtain a list of all Tes Step Statuses, including the default ones, you just need to invoke the following endpoint.
Expand | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||
Responses200 OK : textapplication/plainjson : Successful. Return a json that represents the test runReturns a JSON with all the Test Step Statuses along with some information, including name, description, ranking and mapping to the Test (Run) Status.
400 BAD_REQUEST : text/plain : Returns the error. 401 UNAUTHORIZED : text/plain : The Xray license is not valid. 500 INTERNAL SERVER ERROR : text/plain : An internal error occurred getting the test run. | ||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||
Responses 200 OK : text/plain : Successful.
400 BAD_REQUEST : text/plain : Returns the error. 401 UNAUTHORIZED : text/plain : The Xray license is not valid. 500 INTERNAL SERVER ERROR : text/plain : An internal error occurred updating the test run. |
Status
- To view the status of a Test Run, you need to specify the ID of the Test Run.
- To update the status, an additional parameter is required: the Status that you want the Test Run to have.
Expand | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
400 BAD_REQUEST : text/plain : Returns the error. 401 UNAUTHORIZED : text/plain : The Xray license is not valid. 500 INTERNAL SERVER ERROR : text/plain : An internal error occurred when getting the test run statusgetting the test step statuses. |