Versions Compared

Old Version 1

changes.mady.by.user Sergio Freire

Saved on

compared with

New Version Current

changes.mady.by.user Unknown User (sbgs)

Saved on

Key

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

...

Expand
titleGET api/testrun/{id}/step/{stepResultId}/
Panel
borderColor#ccc
borderStylesolid

Return a json that represents the test step.

Request

PATH PARAMETERS
parameter
type
description
idInteger

- id of the test run.

stepResultIdInteger- id of the step.

Responses

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

Code Block
titleExample Output
{
      "id":729,
      "index":1,
      "step":{
         "raw":"ssaf",
         "rendered":"<p>ssaf</p>"
      },
      "data":{
         "raw":"asdf",
         "rendered":"<p>asdf</p>"
      },
      "result":{
         "raw":"asdfasdf",
         "rendered":"<p>asdfasdf</p>"
      },
      "attachments":[
      ],
      "status":"EXECUTING",
      "comment":{
         "raw":"asdasdasdasdasd",
         "rendered":"<p>asdasdasdasdasd</p>"
      },
      "defects":[
         {
            "id":15018,
            "key":"CALC-115",
            "summary":"Ad-hoc execution for CALC-93",
            "status":"Open"
         }
      ],
      "evidences":[
         {
            "id":216,
            "fileName":"1 (24).feature",
            "fileSize":"0,4 kB",
            "created":"Wednesday 5:09 PM",
            "author":"admin",
			"fileURL": "http://YOURJIRA/jira/plugins/servlet/raven/attachment/253/1 (24).feature"
         }
      ],
	  "actualResult":{
		"raw":"Actual result",
		"rendered":"<p>Actual result</p>"
	  }
   }

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.

Expand
titlePUT api/testrun/{id}/step/{stepResultId}/
Panel
borderColor#ccc
borderStylesolid

Update the test run step. The fields that can be updated on the test run are: status, comment, defects and evidences.

Defects and evidences mentioned directly by the respective attributes are always added to the ones that may exist at the step.

Request

PATH PARAMETERS
 
parameter
type
description
idInteger

- id of the test run.

stepResultIdInteger- id of the step.
Example
Code Block
languagejs
titleExample of input
{
   "id":"729",
   "status":"PASS",
   "comment":"The comment",
   "defects":[
      "TEST-114",
      "TEST-115",
      "TEST-116"
   ],
   "evidences":[
      {
         "filename":"test.txt",
         "contentType":"plain/text",
         "data":"(BASE64 encoding)"
      }
   ],
   "actualResult":"The actual result"
}

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

...