Execution results can be imported to Jira through JSON/XML representation formats specified in Import Execution Results.
For each import file format, Xray provides a specific REST endpoint:
| Import Tests | /api/v1/import/test/bulk |
| Check import job status | /api/v1/import/test/bulk/{jobId}/status |
Import Tests
When importing tests you can use the following endpoint:
POST /api/v1/import/test/bulk
Import the execution results present in query variable "executionResults".
Request
Example 1: new Test Execution
{
"info" : {
"summary" : "Execution of automated tests for release v1.3",
"description" : "This execution is automatically created when importing execution results from an external source",
"version" : "v1.3",
"user" : "admin",
"revision" : "1.0.42134",
"startDate" : "2014-08-30T11:47:35+01:00",
"finishDate" : "2014-08-30T11:53:00+01:00",
"testPlanKey" : "DEMO-100",
"testEnvironments": ["iOS", "Android"]
},
"tests" : [
{
"testKey" : "DEMO-6",
"start" : "2014-08-30T11:47:35+01:00",
"finish" : "2014-08-30T11:50:56+01:00",
"comment" : "Successful execution",
"status" : "PASS"
},
{
"testKey" : "DEMO-7",
"start" : "2014-08-30T11:51:00+01:00",
"finish" : "2014-08-30T11:52:30+01:00",
"comment" : "Execution failed. Example #5 FAIL.",
"status" : "FAIL",
"evidences" : [
{
"data": "iVBORw0KGgoAAAANSUhEUgAABkIAAAO9CAYAAADezXv6AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEn(...base64 file enconding)",
"filename": "image21.jpg",
"contentType": "image/jpeg"
}
],
"examples" : [
"PASS",
"PASS",
"PASS",
"PASS",
"FAIL"
],
"steps": [
{
"status": "PASS",
"comment": "Coment on Test Step Result 1",
"evidences" : [
{
"data": "iVBORw0KGgoAAAANSUhEUgAABkIAAAO9CAYAAADezXv6AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEn(...base64 file enconding)",
"filename": "image22.jpg",
"contentType": "image/jpeg"
}
]
}
],
"defects" : [
"DEMO-10",
"DEMO-11"
]
}
]
}
Example 2: update existing Test Execution
{
"testExecutionKey": "DEMO-1206",
"info" : {
"summary" : "Execution of automated tests for release v1.3",
"description" : "This execution is automatically created when importing execution results from an external source",
"version" : "v1.3",
"user" : "admin",
"revision" : "1.0.42134",
"startDate" : "2014-08-30T11:47:35+01:00",
"finishDate" : "2014-08-30T11:53:00+01:00",
"testPlanKey" : "DEMO-100",
"testEnvironments": ["iOS", "Android"]
},
"tests" : [
{
"testKey" : "DEMO-6",
"start" : "2014-08-30T11:47:35+01:00",
"finish" : "2014-08-30T11:50:56+01:00",
"comment" : "Successful execution",
"status" : "PASS"
}
]
}
Example Request
curl -H "Content-Type: application/json" -X POST -H "Authorization: Bearer $token" --data @"data.json" https://xray.cloud.xpand-it.com/api/v1/import/execution
Responses
200 OK : application/json : Successful. The results where successfully imported to Jira.
{
"testExecIssue": {
"id": "10000",
"key": "DEMO-123",
"self": "http://www.example.com/jira/rest/api/2/issue/10000"
}
}
400 BAD_REQUEST : application/json : No execution results where provided.
401 UNAUTHORIZED : application/json : The Xray license is not valid.
500 INTERNAL SERVER ERROR : application/json : An internal error occurred when importing execution results.