Versions Compared

Old Version 2

changes.mady.by.user Sergio Freire

Saved on

compared with

New Version Current

changes.mady.by.user Pedro Rodrigues

Saved on

Key

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

...

  • To view the Test Executions associated with a Test Plan, you need to specify the key of the Test Plan you wish to view.
    • Both regular and Archived Test Executions associated with a Test Plan will be returned, being differentiated by the property "archived" set as false or true respectively;
  • 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.
    • Both regular and Archived Test Executions associated with a Test Plan will be returned, can be associated or removed from a Test Plan;
  • To remove a Test Execution from a Test Plan, you need to specify the key of the Test Execution you wish to remove.

...

Expand
titleGET /rest/raven/1.0/api/testplan/{testPlanKey}/testexecution
Panel
borderColor#ccc
borderStylesolid

Returns a JSON object with a list of the test executions associated with the test plan.

Request

PATH PARAMETERS
parametertypedescription
testPlanKeyString

- key of the test plan.

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

Code Block
titleExample 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"
	  ],
 	  "archived": false
   },
   {  
      "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"
	  ],
 	  "archived": false
   }
]

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 test executions.

Expand
titlePOST /rest/raven/1.0/api/testplan/{testPlanKey}/testexecution
Panel
borderColor#ccc
borderStylesolid

Associate test executions with the test plan. Return error messages, if there are any.

It's possible to specify if the tests in the test execution should be added to the test plan using the "addTestsToPlan" property in the JSON file. If this setting is empty in the JSON file, the config in the Xray miscellaneous will be used.

Request

PATH PARAMETERS
parametertypedescription
testPlanKeyString

- key of the test plan.

Example
Code Block
titleExample Input
{
	"addTestsToPlan": false,
	"add": [
		"CALC-14",
		"CALC-29"
	],
	"remove": [
		"CALC-15",
		"CALC-50"
	]
}
Tip
titleExample 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.

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

...