Page tree

Documentation of older versions of Xray is available in this page.

Skip to end of metadata
Go to start of metadata

Test Step

  • 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.


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

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

Request

PATH PARAMETERS
parametertypedescription
testKeyString

- key of the test.

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.

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.

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

Return a json with the test step with the given id.

Request

PATH PARAMETERS
parametertypedescription
testKeyString

- key of the test.

idInteger

- ID of the test step.

Example Request

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

Responses

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

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":[
   ]
}

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 step.

 PUT /rest/raven/1.0/api/test/{testKey}/step

Create a new test step.

Request

PATH PARAMETERS
parametertypedescription
testKeyString

- key of the test.

 Example
Example Input
{
   "step":"example step",
   "data":"example data",
   "result":"example result",
   "attachments":[
      {
         "data":"gsddfgdsfg...(base64) ",
         "filename":"example1.txt",
         "contentType":"plain/text"
      },
      {
         "data":"gsddfgdsfg...(base64) ",
         "filename":"example2.txt",
         "contentType":"plain/text"
      }
   ]
}

 

Example Request

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

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

 POST /rest/raven/1.0/api/test/{testKey}/step/{id}

Update a specific test step.

Request

PATH PARAMETERS
parametertypedescription
testKeyString

- key of the test.

idIntegerID of the test step.
 Example
Example Input
{
	"step": "example step",
	"data": "example data",
	"result": "example result",
	"attachments": {
		"add": [{
			"data": "gsddfgdsfg...(base64) ",
			"filename": "example1.txt",
			"contentType": "plain/text"
		}, {
			"data": "gsddfgdsfg...(base64) ",
			"filename": "example2.txt",
			"contentType": "plain/text"
		}],
		"remove": [
			141,
			105
		]
	}
}

Example Request

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

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

 DELETE /rest/raven/1.0/api/test/{testKey}/step/{id}

Remove a test step from a test.

Request

PATH PARAMETERS
parametertypedescription
testKeyString

- key of the test.

idIntegerID of the test step.

Example Request

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

 GET /rest/raven/1.0/api/test/{testKey}/step/{id}/attachment

Return a json with all the test step attachments.

Request

PATH PARAMETERS
parametertypedescription
testKeyString

- key of the test.

idInteger

- ID of the test step.

Example Request

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

Responses

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

Example Output
[
   {
      "id":141,
      "fileName":"text.txt",
      "fileSize":"8,0 kB",
      "created":"Today 3:54 PM",
      "author":"admin",
      "fileURL":"http://YOURJIRA/jira/plugins/servlet/raven/attachment/141/TEST1.txt"
   },
   {
      "id":147,
      "fileName":"text.txt",
      "fileSize":"3,0 kB",
      "created":"Today 3:54 PM",
      "author":"admin",
      "fileURL":"http://YOURJIRA/jira/plugins/servlet/raven/attachment/147/TEST2.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 step attachments.

 DELETE /rest/raven/1.0/api/test/{testKey}/step/{id}/attachment/{attachmentID}

Remove an attachment from a test step.

Request

PATH PARAMETERS
parametertypedescription
testKeyString

- key of the test.

idInteger

- ID of the test step.

attachmentIDInteger- ID of the attachment

Example Request

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

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 step attachment.

  • No labels