You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

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

Xray REST API provides the following endpoints.

Test Plan Tests

To view the Test associated with a Test Plan you need to specify the key of the Test Plan you wish you view. To associate or remove a Test from a Test Plan 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 Plan you need to specify the key of the Test you wish to remove.

 

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

Request

PATH PARAMETERS
parametertypedescription
testPlanKeyString

- key of the test plan.

Example Request

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

Responses

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

Example Output
[  
   {  
      "id":12215,
      "key":"DEMO-12",
      "latestStatus":"PASS"
   },
   {  
      "id":13207,
      "key":"DEMO-29",
      "latestStatus":"TODO"
   },
   {  
      "id":13602,
      "key":"DEMO-44",
      "latestStatus":"Fail"
   }
]

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 plan. Returns error messages if there are any.

Request

PATH PARAMETERS
parametertypedescription
testPlanKeyString

- key of the test plan.

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/testplan/TEST-123/test

Responses

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

Example Output
["Test or Test Set with key CALC-29 not found or is not Type Test or 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 plan.

Request

PATH PARAMETERS
parametertypedescription

testPlanKey

String

- key of the test plan.

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/testplan/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.

 

Test Plan Test Executions

To view the Test executions associated with a Test Plan you need to specify the key of the Test Plan you wish you view. To associate or remove a Test Execution from a Test Plan you need to send a json with a list of the Test Execution keys. To remove a Test from a Test Plan you need to specify the key of the Test Execution you wish to remove.

 

Return a json with a list of the test executions associated with the test plan.

Request

PATH PARAMETERS
parametertypedescription
testPlanKeyString

- key of the test plan.

Example Request

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

Responses

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

Example Output
[  
   {  
      "id":12215,
      "key":"DEMO-12",
      "summary":"Test Execution for Test Plan Test-123",
	  "self":"http://localhost:5980/testJira/rest/api/2/issue/12215",
	  "environments" : [
		"IOS",
		"Android"
	  ]
   },
   {  
      "id":12315,
      "key":"DEMO-15",
      "summary":"Test Execution for Test Plan Test-123",
	  "self":"http://localhost:5980/testJira/rest/api/2/issue/12315",
	  "environments" : [
		"IOS",
		"Android"
	  ]
   }
]

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 test executions with the test plan. Returns error messages if there are any.

Request

PATH PARAMETERS
parametertypedescription
testPlanKeyString

- key of the test plan.

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/testplan/TEST-123/testexecution

Responses

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

Example Output
["Issue with key CALC-29 not found or is not of type Test Execution"]

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 execution from the test plan.

Request

PATH PARAMETERS
parametertypedescription

testPlanKey

String

- key of the test plan.

testExecKeyString- key of the test.

Example Request

curl -H "Content-Type: application/json" -X DELETE -u admin:admin http://yourserver/rest/raven/1.0/api/testplan/TEST-123/testexecution/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