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.
Return a json with the test steps of a given test.
Request
PATH PARAMETERS
| parameter | type | description |
|---|---|---|
testKey | String | - key of the test. |
Example Request
Responses
200 OK : text/plain : Successful. Return a json.
[
{
"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.
Return a json with the test step with the given id.
Request
PATH PARAMETERS
| parameter | type | description |
|---|---|---|
testKey | String | - key of the test. |
| id | Integer | - id of the test step. |
Example Request
Responses
200 OK : text/plain : Successful. Return a json.
{
"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.
Creates a new test step.
Request
PATH PARAMETERS
| parameter | type | description |
|---|---|---|
testKey | String | - key of the test. |
Example
{
"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
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.
Updates a specific test step.
Request
PATH PARAMETERS
| parameter | type | description |
|---|---|---|
testKey | String | - key of the test. |
| id | Integer | - id of the test step. |
Example
{
"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
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.
Removes a test step from a test.
Request
PATH PARAMETERS
| parameter | type | description |
|---|---|---|
testKey | String | - key of the test. |
| id | Integer | - id of the test step. |
Example Request
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.
Return a json with all the test step attachments.
Request
PATH PARAMETERS
| parameter | type | description |
|---|---|---|
testKey | String | - key of the test. |
| id | Integer | - id of the test step. |
Example Request
Responses
200 OK : text/plain : Successful. Return a json.
[
{
"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.
Removes an attachement from a test step.
Request
PATH PARAMETERS
| parameter | type | description |
|---|---|---|
testKey | String | - key of the test. |
| id | Integer | - id of the test step. |
| attachmentID | Integer | - id of the attachment |
Example Request
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.