Page tree

This is the documentation of Xray Server. If you are looking for Xray Cloud, visit this page. Documentation of older versions of Xray Server is available in this page.

Skip to end of metadata
Go to start of metadata

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.


Test Statuses

To obtain a list of all Test (Run) Statuses, including the default ones, you just need to invoke the following endpoint.


 GET /rest/raven/1.0/api/settings/teststatuses

Returns a JSON object with all the Test (Run) Statuses.

Request


Example Request

curl -H "Content-Type: application/json" -X GET -u admin:admin http://yourserver/rest/raven/1.0/api/settings/teststatuses

Responses

200 OK : application/json : Successful. Returns a JSON with all the Test (Run) Statuses along with some information, including name, description, ranking and mapping to the requirement status.

Example Output
[
 {
   "id": 1,
   "rank": 1,
   "name": "PASS",
   "description": "The test run has passed",
   "final": true,
   "color":"#0a9600",
   "requirementStatusName": "OK"
 },
 {
   "id": 10,
   "rank": 10,
   "name": "BLOCKED",
   "description": "The test run is blocked"
   "final": false,
   "color": "#000000",
   "requirementStatusName": "NOTRUN"
 }
 ...
]

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


Test Step Statuses

To obtain a list of all Tes Step Statuses, including the default ones, you just need to invoke the following endpoint.


 GET /rest/raven/1.0/api/settings/teststepstatuses

Returns a JSON object with all the Test Step Statuses.

Request


Example Request

curl -H "Content-Type: application/json" -X GET -u admin:admin http://yourserver/rest/raven/1.0/api/settings/teststepstatuses

Responses

200 OK : application/json : Successful. Returns a JSON with all the Test Step Statuses along with some information, including name, description, ranking and mapping to the Test (Run) Status.

Example Output
[
 {
   "id": 1,
   "rank": 1,
   "name": "PASS",
   "description": "The test step has passed."
   "testStatusId": 1 
 },
 {
   "id": 10,
   "rank": 10,
   "name": "SKIP",
   "description": "The test step has been skipped."
   "testStatusId": 1 
 }
 ...
]

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 step statuses.



  • No labels