Versions Compared

Key

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

...

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

Return a json that contains the test step status.

Request

PATH PARAMETERS
parameter
type
description
idInteger

- id of the test run.

stepResultIdInteger- id of the step.
Tip
titleExample Request
curl -H "Content-Type: application/json" -X GET -u admin:admin http://yourserver/rest/raven/1.0/api/testrun/3/step/2/status

Responses

200 OK : text/plain : Successful. Returns the name of the test step 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 api/testrun/{id}/step/{stepResultId}/status
Panel
borderColor#ccc
borderStylesolid

Update the test step status.

Request

PATH PARAMETERS
parameter
type
description
idInteger

- id of the test run.

stepResultIdInteger- id of the step.
QUERY PARAMETERS
parametertypedescription
statusString- The status we want the test step 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/step/2/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 step status.

...