You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

You can manage (i.e. create, update, delete) Test Executions directly through the JIRA's native REST API.

Xray REST API provides the following endpoints.

Test Execution Tests

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 this keys can be Test keys or Test Set keys but 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.

 

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

Request

PATH PARAMETERS
parametertypedescription
testExecKeyString

- key of the test execution.

QUERY PARAMETERS
parametertypedescription
detailedboolean

- if true will display detailed information about the test run

 

 

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.

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"
   }
]
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.

Associates tests with the test execution. Returns error messages if there are any.

Request

PATH PARAMETERS
parametertypedescription
testExecKeyString

- key of the test execution.

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

Example Request

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


Responses

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

Example Output
["Issue with key CALC-99 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.

Removes test from the test execution.

Request

PATH PARAMETERS
parametertypedescription
testExecKeyString

- key of the test execution.

testKeyString- key of the test.

Example Request

curl -H "Content-Type: application/json" -X DELETE -u admin:admin http://yourserver/rest/raven/1.0/api/testexec/TEST-123/test/TEST-321
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.

  • No labels