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:

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

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.

[
 {
   "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.