if the environment contains a comma escape it with '\'
Tip
title
Example Request
curl -H "Content-Type: application/json" -X GET -u admin:admin http://yourserver/rest/raven/1.0/api/test/{key}/testruns
curl -H "Content-Type: application/json" -X GET -u admin:admin http://yourserver/rest/raven/1.0/api/test/{key}/testruns?testEnvironments=IOS,Android
Responses
200 OK : text/plain : Successful. Return a json.
Code Block
title
Example Output
[
{
"id":1587,
"status":"FAIL",
"testKey":"CALC-12",
"testExecKey":"CALC-13",
"assignee":"admin",
"executedBy":"admin",
"startedOn":"2016-10-11T17:15:05+01:00",
"finishedOn":"2016-10-24T14:58:34+01:00",
"duration":1115009068,
"defects":[
{
"id":12410,
"key":"PER-174",
"summary":"Test Bug",
"status":"Open"
}
],
"evidences":[
{
"id":383,
"fileName":"result.json",
"fileSize":"15 kB",
"created":"Today 5:41 PM",
"author":"admin",
"fileURL":"http://JIRASERVER/plugins/servlet/raven/attachment/383/result.json"
}
],
"scenarioOutline":"Given I have entered <input_1> into the calculator And I have entered <input_2> into the calculator When I press <button> Then the result should be <output> on the screen Examples: | input_1 | input_2 | button | output | | 20 | 30 | add | 50 | | 2 | 5 | add | 7 | | 0 | 40 | add | 40 |",
"examples":[
{
"id":1,
"rank":0,
"values":[
"input_1",
"input_2",
"button",
"output"
],
"status":"PASS"
},
{
"id":2,
"rank":1,
"values":[
"20",
"30",
"add",
"50"
],
"status":"FAIL"
},
{
"id":3,
"rank":2,
"values":[
"2",
"5",
"add",
"7"
],
"status":"PASS"
},
{
"id":4,
"rank":3,
"values":[
"0",
"40",
"add",
"40"
],
"status":"PASS"
}
]
},
{
"id":1588,
"status":"TODO",
"testKey":"CALC-12",
"testExecKey":"CALC-13",
"assignee":"admin",
"defects":[
{
"id":12410,
"key":"PER-174",
"summary":"Test Bug",
"status":"Open"
}
],
"evidences":[
{
"id":383,
"fileName":"result.json",
"fileSize":"15 kB",
"created":"Today 5:41 PM",
"author":"admin",
"fileURL":"http://JIRASERVER/plugins/servlet/raven/attachment/383/result.json"
}
],
"scenarioOutline":"Given I have entered <input_1> into the calculator And I have entered <input_2> into the calculator When I press <button> Then the result should be <output> on the screen Examples: | input_1 | input_2 | button | output | | 20 | 30 | add | 50 | | 2 | 5 | add | 7 | | 0 | 40 | add | 40 |",
"examples":[]
}
]
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 steps.
...
Expand
title
GET /rest/raven/1.0/api/test/{key}/preconditions
Panel
Return a json with the test pre-conditions of a given test.
Request
PATH PARAMETERS
parameter
type
description
key
String
- key of the test.
Tip
Example Request curl -H "Content-Type: application/json" -X GET -u admin:admin http://yourserver/rest/raven/1.0/api/test/FLYTOMOON-76/preconditions
Responses
200 OK : text/plain : Successful. Return a json.
Code Block
title
Example Output
[
{
"id": 12602,
"rank": 1,
"key": "FLYTOMOON-7",
"self": "http://localhost:8080/rest/api/2/issue/12602",
"reporter": "john",
"assignee": "bmpc",
"type": "Manual",
"condition": "Fuel the rockets before launch"
},
{
"id": 13409,
"rank": 2,
"key": "FLYTOMOON-77",
"self": "http://localhost:8080/rest/api/2/issue/13409",
"reporter": "admin",
"assignee": "admin",
"type": "Manual",
"condition": "The PC must be turned on"
},
{
"id": 12718,
"rank": 3,
"key": "FLYTOMOON-29",
"self": "http://localhost:8080/rest/api/2/issue/12718",
"reporter": "admin",
"assignee": "admin",
"type": "Manual",
"condition": "Ligar o computador.."
}
]
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 pre-conditions.
...
Expand
title
GET /rest/raven/1.0/api/test/{key}/testsets
Panel
borderColor
#ccc
borderStyle
solid
Return a json with the exported test sets.
Request
PATH PARAMETERS
parameter
type
description
key
String
- Test Key
Tip
title
Example Request
curl -H "Content-Type: application/json" -X GET -u admin:admin http://yourserver/rest/raven/1.0/api/test/{key}/testsets
Responses
200 OK : text/plain : Successful. Return a json.
Code Block
title
Example Output
[
{
"id":13602,
"key":"CALC-50",
"summary":"Test Set for all tests",
"self":"http://JIRASERVER/testJira/rest/api/2/issue/CALC-50",
"environments" : [
"IOS",
"Android"
]
},
{
"id":13600,
"key":"CALC-51",
"summary":"Test Set of v2.0",
"self":"http://JIRASERVER/testJira/rest/api/2/issue/CALC-51",
"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 test steps.
...
Expand
title
GET /rest/raven/1.0/api/test/{key}/testexecutions
Panel
borderColor
#ccc
borderStyle
solid
Return a json with the exported test executions.
Request
PATH PARAMETERS
parameter
type
description
key
String
- Test Key
Tip
title
Example Request
curl -H "Content-Type: application/json" -X GET -u admin:admin http://yourserver/rest/raven/1.0/api/test/{key}/testexecutions
Responses
200 OK : text/plain : Successful. Return a json.
Code Block
title
Example Output
[
{
"id":13602,
"key":"CALC-52",
"summary":"Test Execution for all tests",
"self":"http://JIRASERVER/testJira/rest/api/2/issue/CALC-52"
},
{
"id":13600,
"key":"CALC-53",
"summary":"Test Execution of v2.0",
"self":"http://JIRASERVER/testJira/rest/api/2/issue/CALC-53"
}
]
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 steps.
...
Expand
title
GET /rest/raven/1.0/api/test/{key}/testplans
Panel
borderColor
#ccc
borderStyle
solid
Return a json with the exported test plans.
Request
PATH PARAMETERS
parameter
type
description
key
String
- Test Key
Tip
title
Example Request
curl -H "Content-Type: application/json" -X GET -u admin:admin http://yourserver/rest/raven/1.0/api/test/{key}/testplans
Responses
200 OK : text/plain : Successful. Return a json.
Code Block
title
Example Output
[
{
"id":13602,
"key":"CALC-54",
"summary":"Test Plan for all tests",
"self":"http://JIRASERVER/testJira/rest/api/2/issue/CALC-54"
},
{
"id":13600,
"key":"CALC-55",
"summary":"Test Plan of v2.0",
"self":"http://JIRASERVER/testJira/rest/api/2/issue/CALC-55"
}
]
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 steps.