Returns a JSON object with a list of the Tests contained in a given folder of the Test Repository. This endpoint supports pagination. Request PATH PARAMETERS parameter | type | description |
---|
projectKey | String | project key | folderId | Integer | internal folder Id; "-1" corresponds to the root folder of the Test Repository |
QUERY PARAMETERS parameter | type | description |
---|
allDescendants | Boolean | include all descendants (i.e. all child Tests); "false", by default | page | Integer | page of paginated data (first 1) | limit | Integer | amount of Tests per paginated data |
curl -H "Content-Type: application/json" -X GET -u admin:admin http://yourserver/rest/raven/1.0/api/testrepository/<projectKey>/folders/<folderId>/tests curl -H "Content-Type: application/json" -X GET -u admin:admin http://yourserver//rest/raven/1.0/api/testrepository/<projectKey>/folders/<folderId>/tests?allDescendants=true |
Responses 200 OK : text/plain : Successful. Returns a JSON object containing the Tests.
Each test will provide some information, including: id : internal Test Idkey : Test's issue keysummary : Test's summary- assignee: Test's issue assignee
rank : rank of the Test in the parent folder ("1" corresponds to the first element)workflowStatus : Test's workflow status- labels: array of all Test's assigned labels
components : array of all Test's assigned componentstestType : Test type (e.g. "Manual", "Cucumber, "Generic")
{
"tests": [
{
"id": 24300,
"key": "FP-10",
"summary": "Issue test create inside folder",
"assignee": "",
"rank": 1,
"workflowStatus": "Open",
"labels": [],
"components": [],
"testType": "Manual",
},
{
"id": 24301,
"key": "FP-11",
"summary": "Issue test create inside folder",
"assignee": "",
"rank": 2,
"workflowStatus": "Open",
"labels": [],
"components": [],
"testType": "Manual",
},
{
...
}
],
"total": 3,
} |
{
"tests": [
{
"id": 24300,
"key": "FP-10",
"summary": "Issue test create inside folder",
"assignee": "",
"rank": 1,
"workflowStatus": "Open",
"labels": [],
"components": [],
"testType": "Manual",
},
{
"id": 24301,
"key": "FP-11",
"summary": "Issue test create inside folder",
"assignee": "",
"rank": 1,
"workflowStatus": "Open",
"labels": [],
"components": [],
"testType": "Manual",
},
{
...
}
],
"total": 3,
} |
400 BAD_REQUEST : text/plain : Returns the error. 401 UNAUTHORIZED : text/plain : The Xray license is not valid. 500 INTERNAL SERVER ERROR : text/plain : An internal error occurred getting the tests. |