Page History

Versions Compared

Key

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

...

Expand

title	GET /rest/raven/1.0/api/testrepository/<projectKey>/folders/<folderId>/tests

Panel

borderColor	#ccc
borderStyle	solid

Return a JSON object with a list of the Tests contained in a given folder of the Test Repository.

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

Tip

title	Example Request

curl -H "Content-Type: application/json" -X GET -u admin:admin http://yourserver/rest/raven/1.0/api/testrepository/<projectKey>/folders/<folderId>/tests

Tip

title	Example Request

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 Id
key: Test's issue key
summary: 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 components
testType: Test type (e.g. "Manual", "Cucumber, "Generic")

Code Block

title	Output example for listing only the direct descendants of a given folder

{
 "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,
}

Code Block

title	Output example for listing all descendants of a given folder

{
 "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 for JIRA license is not valid.

500 INTERNAL SERVER ERROR : text/plain : An internal error occurred getting the tests.

...

FOLDERS XXXXXXXX

To view the Tests associated with a Test Execution, you need to specify the key of the Test Execution you want to view.
To associate or remove a Test from a Test Execution, you need to send a JSON with a list of the keys. When associating, these keys can be Test keys or Test Set keys; when removing, they have to be Test keys.
To remove a Test from a Test Execution, you need to specify the key of the Test you wish to remove.

...

Expand

title	GET /rest/raven/1.0/api/testexec/{testExecKey}/test

Panel

borderColor	#ccc
borderStyle	solid

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

Request

PATH PARAMETERS

parameter	type	description
`testExecKey`	String	- key of the test execution.

QUERY PARAMETERS

parameter	type	description
`detailed`	boolean	- if true will display detailed information about the test run

Tip

title	Example Request

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

curl -H "Content-Type: application/json" -X GET -u admin:admin http://yourserver/rest/raven/1.0/api/testexec/TEST-123/test?detailed=true

Responses

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

Code Block

title	Example Output

[
   {
      "id":204,
      "key":"CALC-10",
      "rank":1,
      "status":"FAIL"
   },
   {
      "id":205,
      "key":"CALC-44",
      "rank":2,
      "status":"FAIL"
   },
   {
      "id":326,
      "key":"CALC-66",
      "rank":3,
      "status":"TODO"
   },
   {
      "id":380,
      "key":"CALC-42",
      "rank":4,
      "status":"TODO"
   }
]

Code Block

title	Example Output

[
   {
      "id":204,
      "status":"FAIL"
	  "assignee":"admin",
	  "executedBy":"admin",
      "startedOn":"Friday 10:13 AM",
      "finishedOn":"Friday 10:13 AM",
      "defects":[  
         {  
            "id":10607,
            "key":"PER-71",
            "summary":"1234",
            "status":"Open"
         }
      ],
      "evidences":[  
         {  
            "id":25,
            "fileName":"stepsDATA.csv",
            "fileSize":"0,1 kB",
            "created":"Friday 10:16 AM",
            "author":"admin",
            "fileURL":"http://localhost:5980/testJira/plugins/servlet/raven/attachment/25/stepsDATA.csv"
         }
      ],
      "key":"PER-46",
      "rank":1
   },
   {
      "id":60,
      "status":"FAIL",
      "executedBy":"admin",
      "startedOn":"Friday 10:13 AM",
      "finishedOn":"Friday 10:13 AM",
      "defects":[  
      ],
      "evidences":[  
      ],
      "key":"PER-41",
      "rank":2
   },
   {  
      "id":61,
      "status":"ABORTED",
      "executedBy":"blake",
      "startedOn":"Friday 10:13 AM",
      "finishedOn":"Friday 10:13 AM",
      "defects":[  
      ],
      "evidences":[  
      ],
      "key":"PER-33",
      "rank":3
   }
]

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.

Expand

title	POST PATCH /rest/raven/1.0/api/testrepository/<projectKey>/testexec/{testExecKey}/testfolders/<folderId>\/tests

Panel

borderColor	#ccc
borderStyle	solid

Associate tests with the test execution. Return Add/remove tests to/from the given Test Repository folder. Returns error messages, if there are any.

Request

PATH PARAMETERS

parameter	type	description

testExecKey

projectKey String

- key of the test execution.

project key
folderId	integer	internal folder Id

Example

Code Block

title	Example Input

{
    "add": [
        ""CALC-33",
        "CALC-75"
    ],
    "remove": [
        "CALC-25",
        "CALC-45"
    ]
}

Tip

title	Example Request

curl -H "Content-Type: application/json" -X POST PATCH -u admin:admin --data @example.json http://yourserver/rest/raven/1.0/api/testexec/TEST-123/test testrepository/FP/folders/9/tests

Responses

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

Code Block

title	Example Output

["Issue with key CALC-9933 not found or is not of 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.

Expand

title	DELETE /rest/raven/1.0/api/testexectestrepository/{testExecKey}<projectKey>/testfolders/{testKey}<folderId>

- key of the test.

Panel

borderColor	#ccc
borderStyle	solid

Remove test folder from the test executionTest Repository.

Request

PATH PARAMETERS

parameter	type	description

testExecKey

projectKey String

project key

of the test execution.

testKey

folderId

String

integer

internal folder Id

Tip

title	Example Request

curl -H "Content-Type: application/json" -X DELETE -u admin:admin http://yourserver/rest/raven/1.0/api/testexectestrepository/TEST-123FP/testfolders/TEST-321 6

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.

Content

Space Tools

Versions Compared

Old Version 9

New Version 10

Key

Request

PATH PARAMETERS

QUERY PARAMETERS

Responses

FOLDERS XXXXXXXX

Request

PATH PARAMETERS

QUERY PARAMETERS

Responses

Request

PATH PARAMETERS

Example

Request

PATH PARAMETERS

Responses