Versions Compared

Old Version 2

changes.mady.by.user user-0caa0

Saved on

compared with

New Version 3

changes.mady.by.user user-0caa0

Saved on

Key

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

...

Expand
titleGET /rest/raven/1.0/api/testrun/{id}/
Panel
borderColor#ccc
borderStylesolid

Return a json that represents the test run.

Request

PATH PARAMETERS
parametertypedescription
idinteger

- id of the test run.

Tip
titleExample Request
curl -H "Content-Type: application/json" -X GET -u admin:admin http://yourserver/rest/raven/1.0/api/testrun/2

Responses

200 OK : text/plain : Successful. Return a json that represents the test run.

Code Block
titleExample Output
{
   "id":371,
   "status":"TODO",
   "testKey":"CALC-12",
   "testExecKey":"CALC-13",
   "assignee":"admin",
   "executedBy":"admin",
   "startedOn":"2016-10-11T17:14:03+01:00",
   "finishedOn": "2016-10-24T14:58:35+01:00",
   "duration": 1115072328,
   "defects":[
      {
         "id":15017,
         "key":"test-114",
         "summary":"summary 1",
         "status":"Open"
      },
      {
         "id":15018,
         "key":"test-115",
         "summary":"summary 2",
         "status":"Open"
      }
   ],
   "evidences":[
      {
         "id":313,
         "fileName":"stuff.txt",
         "fileSize":"0,0 kB",
         "created":"2016-10-24T15:50:57+01:00",
         "author":"admin",
         "fileURL":"http://lenovo-pc:2990/jira/plugins/servlet/raven/attachment/313/stuff.txt"
      },
      {
         "id":314,
         "fileName":"stuff2.txt",
         "fileSize":"0,0 kB",
         "created":"2016-10-24T15:50:57+01:00",
         "author":"admin",
         "fileURL":"http://lenovo-pc:2990/jira/plugins/servlet/raven/attachment/314/stuff2.txt"
      }
   ],
   "comment":"new comment",
   "scenarioOutline":"Given I have entered <input_1> into the calculator\r\nAnd I have entered <input_2> into the calculator\r\nWhen I press <button>\r\nThen the result should be <output> on the screen\r\n\r\n  Examples:\r\n    | input_1 | input_2 | button | output |\r\n    | 20      | 30      | add    | 50     |\r\n    | 2       | 5       | add    | 7      |\r\n    | 0       | 40      | add    | 40     |",
   "examples":[
      {
         "id":1377,
         "rank":0,
         "values":[
            "input_1",
            "input_2",
            "button",
            "output"
         ],
         "status":"PASS",
         "statusDescription":"The test run has passed"
      },
      {
         "id":1378,
         "rank":1,
         "values":[
            "20",
            "30",
            "add",
            "50"
         ],
         "status":"PASS",
         "statusDescription":"The test run has passed"
      },
      {
         "id":1379,
         "rank":2,
         "values":[
            "2",
            "5",
            "add",
            "7"
         ],
         "status":"PASS",
         "statusDescription":"The test run has passed"
      },
      {
         "id":1380,
         "rank":3,
         "values":[
            "0",
            "40",
            "add",
            "40"
         ],
         "status":"PASS",
         "statusDescription":"The test run has passed"
      }
   ],
   "environments" : [
	  "IOS",
	  "Android"
	  ]
}

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 test run.

...

  • To view the status of a Test Run, you need to specify the ID of the Test Run.
  • To update the status, an additional param parameter is required: the Status that we you want the Test Run to have.

...

Expand
titleGET /rest/raven/1.0/api/testrun/{id}/status
Panel
borderColor#ccc
borderStylesolid

Return a json that contains the test run status.

Request

PATH PARAMETERS
parametertypedescription
idinteger

- id  ID of the test run.

Tip
titleExample Request
curl -H "Content-Type: application/json" -X GET -u admin:admin http://yourserver/rest/raven/1.0/api/testrun/3/status

Responses

200 OK : text/plain : Successful. Returns the name of the test run Status. 

Code Block
titleExample Output
PASS

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 when getting the test run status.

Expand
titlePUT /rest/raven/1.0/api/testrun/{id}/status
Panel
borderColor#ccc
borderStylesolid

Updates the test run status.

Request

PATH PARAMETERS
parametertypedescription
idinteger

- ID of the test run.

QUERY PARAMETERS
parametertypedescription
statusString- The status we status you want the test run to have.
Tip
titleExample Request
curl -H "Content-Type: application/json" -X PUT -u admin:admin http://yourserver/rest/raven/1.0/api/testrun/3/status?status=PASS

Responses

200 OK : text/plain : Successful.

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 when updating the test run status.

...

Expand
titleDELETE /rest/raven/1.0/api/testrun/{id}/defect/{issueIdOrKey}
Panel
borderColor#ccc
borderStylesolid

Remove one or more defects from the test run.

  Request

PATH PARAMETERS
parametertypedescription
idinteger

- ID of the test run.

issueIdOrKeyString or Integer

- ID or key of the issue we issue you want to remove from the defects.

Tip
titleExample Request
curl -H "Content-Type: application/json" -X DELETE -u admin:admin http://yourserver / rest/raven/1.0/api/testrun/2/defect/TEST-421

Responses

200 OK : text/plain : Successful.

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 when inserting the defects.

...

Expand
titleDELETE /rest/raven/1.0/api/testrun/{id}/attachment
Panel
borderColor#ccc
borderStylesolid

Remove all evidences with the same filename from the test run.

Request

PATH PARAMETERS
parametertypedescription
idinteger

- id  ID of the test run.

Example
Code Block
titleExample Input
image.png
Tip
titleExample Request
curl -H "Content-Type: application/json" -X DELETE -u admin:admin --data @example.json http://yourserver / rest/raven/1.0/api/testrun/2/attachment

Responses

200 OK : text/plain : Successful.

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 when deleting the evidences .

...