Page History

Versions Compared

Key

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

...

To view all the test steps, you need to specify the key of the Test you want to view the test steps.
To view a specific test step, you need to specify the ID of the test step.
To create a new test step, you need to send a JSON with the information you want the test step you have.
To update a test step, you need to send a JSON with the information you want to update.
To delete a test step, you need to specify the ID of the test step you want to delete.
To view all the attachments of a test step, you need to specify the ID of the test step you want to view the attachments from.
To delete an attachment, you need to specify the ID of the attachments you want to delete.

asdasdasdasdsa

Expand

title	GET /rest/raven/1.0/api/test/{testKey}/step

Panel

borderColor	#ccc
borderStyle	solid

Return a json with the test steps of a given test.

Request

PATH PARAMETERS

parameter	type	description
`testKey`	String	- key of the test.

Tip

title	Example Request

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

Responses

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

Code Block

title	Example Output

[
   {
      "id":311,
      "index":1,
      "step":{
         "raw":"Enter the following operation on screen",
         "rendered":"<p>Enter the following operation on screen</p>"
      },
      "data":{
         "raw":"(1 + 1) * 2",
         "rendered":"<p>(1 + 1) * 2</p>"
      },
      "result":{
         "raw":"The expected result is *4*",
         "rendered":"<p>The expected result is <b>4</b></p>"
      },
      "attachments":[
      ]
   },
   {
      "id":312,
      "index":2,
      "step":{
         "raw":"test",
         "rendered":"<p>test</p>"
      },
      "data":{
         "raw":"test data",
         "rendered":"<p>test data</p>"
      },
      "result":{
         "raw":"expected data",
         "rendered":"<p>expected data</p>"
      },
      "attachments":[
         {
            "id":141,
            "fileName":"text.txt",
            "fileSize":"0,0 kB",
            "created":"Today 3:54 PM",
            "author":"admin",
            "fileURL":"http://YOURJIRA/jira/plugins/servlet/raven/attachment/141/text.txt"
         }
      ]
   }
]

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

...

Content

Space Tools

Versions Compared

Old Version 5

New Version 6

Key

PATH PARAMETERS

Responses