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

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 you 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 this keys can be Test keys or Test Set keys but 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 Test from the Test Set.

Return a json with a list of the test associated with the test set.

Request

PATH PARAMETERS

parameter	type	description
`testSetKey`	String	- key of the test set.

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 in a explicitly detailed request in a future release.

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

Associates tests with the test set. Returns error messages if there are any.

Request

PATH PARAMETERS

parameter	type	description
`testSetKey`	String	- key of the test set.

Example

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

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.

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

Removes test from the test set.

Request

PATH PARAMETERS

parameter	type	description
`testSetKey`	String	- key of the test set.
testKey	String	- key of the test.

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.