Versions Compared

Old Version 11

changes.mady.by.user Sergio Freire

Saved on

compared with

New Version Current

changes.mady.by.user Sergio Freire

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
maxLevel2

Test Statuses

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


Expand
titleGET /rest/raven/1.0/api/settings/teststatuses
Panel
borderColor#ccc
borderStylesolid

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

Request


Tip
titleExample 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.

Code Block
titleExample 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.


Expand
titleGET /rest/raven/1.0/api/settings/teststepstatuses
Panel
borderColor#ccc
borderStylesolid

Returns a JSON object with all the Test Step Statuses.

Request


Tip
titleExample 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.

Code Block
titleExample 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.