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

You can manage (i.e., create, update, delete) Test Sets directly through the Jira's native REST API.

The Xray REST API provides the following endpoints.

Test Set Tests

  • To view the Test associated with a Test Set, you need to specify the key of the Test Set you wish to view.
  • To associate or remove a Test from a Test Set, 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 can only be Test keys.
  • To remove a Test from a Test Set, you need to specify the key of the Test you wish to remove. It is also possible to remove all Tests from the Test Set. 


 GET /rest/raven/1.0/api/testset/{testSetKey}/test

Return ajsonwith a list of the test associated with the test set. Note that this endpoint may be paginated.

Request

PATH PARAMETERS
parametertypedescription
testSetKeyString

- key of the test set.

QUERY PARAMETERS
parametertypedescription
limitInteger

- limits the number of results per page. Should be greater or equal to 0 and lower or equal to the maximum set in the Global Configuration.

pageInteger

-numberof the page to be retuned. Should be greater or equal to 1.



Example Request

curl -H "Content-Type: application/json" -X GET -u admin:admin http://yourserver/rest/raven/1.0/api/testset/TEST-123/test

Responses

200 OK : text/plain : Successful. Return a json.


The "rank" and "key" will clearly identify the Test and its order within the Test Set. Note that the output may currently return other fields, which may only be available ina explicitlydetailed request in a future release.

Example Output
[
   {
      "id":13602,
      "rank":1,
      "key":"CALC-44",
      "self": "http://jiraserver/rest/api/2/issue/10401"
   },
   {
      "id":13600,
      "rank":2,
      "key":"CALC-42",
      "self": "http://jiraserver/rest/api/2/issue/10402"
   },
   {
      "id":13886,
      "rank":3,
      "key":"CALC-66",
      "self": "http://jiraserver/rest/api/2/issue/10403"
   }
]

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

 POST /rest/raven/1.0/api/testset/{testSetKey}/test

Associate tests with the test set. Return error messages, if there are any.

Request

PATH PARAMETERS
parametertypedescription
testSetKeyString

- key of the test set.

Example
Example Input
{
	"add": [
		"CALC-14",
		"CALC-29"
	],
	"remove": [
		"CALC-15",
		"CALC-50"
	]
}

Example Request

curl -H "Content-Type: application/json" -X POST -u admin:admin --data @example.json http://yourserver/rest/raven/1.0/api/testset/TEST-123/test

Responses

200 OK : text/plain : Successful. Returns error messages if there are any.

Example Output
["Test with key CALC-29 is already associated with this Test Set."]

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 the tests.

 DELETE /rest/raven/1.0/api/testset/{testSetKey}/test/{testKey}

Removetestfrom the test set.

Request

PATH PARAMETERS
parametertypedescription
testSetKeyString

- key of the test set.

testKeyString- key of the test.

Example Request

curl -H "Content-Type: application/json" -X DELETE -u admin:admin http://yourserver/rest/raven/1.0/api/testset/TEST-123/test/TEST-321
Responses

200 OK : text/plain : Successful.

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 removing the test.

  • No labels