PUT /testrun/{id}
Update all the values of a Test Run.
The user can update the values of the overall status, step results, assignee, test environments, add defects and evidences and so on.
To update the value of a Test Run custom field, the id of the field must be provided as well as a valid value for that custom field type.
- Toggle Fields values should be "true", "false", "0" or "1"
- Number Fields values should be a string containing a number, e.g. "320". Decimal Number are also accepted,for instance, "320.5". The decimal places are always separated by a "."
- Single Select and Radio Button Fields values should be a single string containing the option value, e.g. "Option A". The value should be a valid option for that custom field. The values are not case sensitive.
- Multiple Select Fields values should be an array of the string of option values, e.g. ["Option A", "Option B"]. All the selected values should be valid for that custom field. The option values are not case sensitive.
- Date Fields should follow the ISO format yyyy-MM-dd, where yyyy represents the year, MM the month in year and dd the day in the month. For instance, a valid value would be "2020-05-02".
- Date Time fields should be in UTC following the ISO format yyyy-MM-dd'T'HH:mm'Z'. The date part follows the same date format, while HH represents the hours (0-24), mm the minutes in hour and Z indicates the hour in UTC. For instance, a valid date time value would be "2020-05-02T10:30Z".
An error will be returned when there are invalid custom field values.
It is also possible to delete a Test Run custom field value by providing a null or empty value (e.g., "" or []). It is not possible to delete a value of a required Test Run Custom Field value.
Also, it is not possible to change the Test Run to a final status when there are required Test Run custom fields with empty values.
In the case of a Test Run of a manual Test type, it is possible to update the steps only if there are zero or one iterations. If there are multiple iterations, it is not possible to update the steps through this endpoint, only the iterations.
Servers
- https://sandbox.xpand-it.com/rest/raven/2.0/api
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
The id of the Test Run |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
assignee |
String | No | |
comment |
String | No | |
evidences |
Object | No | |
evidences.remove[] |
Array | No | |
evidences.add[] |
Array | No | |
evidences.add[].data |
String | No | |
evidences.add[].contentType |
String | No | |
evidences.add[].filename |
String | No | |
defects |
Object | No | |
defects.remove[] |
Array | No | |
defects.add[] |
Array | No | |
customFields[] |
Array | No | |
iterations[] |
Array | No | |
iterations[].id |
Integer | No | |
iterations[].status |
String | No | |
examples |
Object | No | |
examples.id |
String | No | |
examples.values[] |
Array | No | |
examples.rank |
Integer | No | |
examples.steps[] |
Array | No | |
examples.steps[].id |
Integer | No | |
examples.steps[].name |
String | No | |
examples.steps[].rank |
Integer | No | |
examples.steps[].type |
String | No | |
examples.steps[].status |
String | No | |
examples.steps[].keyword |
String | No | |
examples.steps[].duration |
String | No | |
examples.steps[].logError |
String | No | |
examples.statusDescription |
String | No | |
examples.backgrounds[] |
Array | No | |
examples.backgrounds[].id |
Integer | No | |
examples.backgrounds[].name |
String | No | |
examples.backgrounds[].rank |
Integer | No | |
examples.backgrounds[].type |
String | No | |
examples.backgrounds[].status |
String | No | |
examples.backgrounds[].keyword |
String | No | |
examples.backgrounds[].duration |
String | No | |
examples.backgrounds[].logError |
String | No | |
examples.hooks[] |
Array | No | |
examples.hooks[].id |
Integer | No | |
examples.hooks[].name |
String | No | |
examples.hooks[].rank |
Integer | No | |
examples.hooks[].type |
String | No | |
examples.hooks[].status |
String | No | |
examples.hooks[].keyword |
String | No | |
examples.hooks[].duration |
String | No | |
examples.hooks[].logError |
String | No | |
examples.status |
String | No | |
examples.duration |
String | No | |
steps[] |
Array | No | |
steps[].id |
Integer | No | |
steps[].comment |
String | No | |
steps[].evidences |
Object | No | |
steps[].evidences.remove[] |
Array | No | |
steps[].evidences.add[] |
Array | No | |
steps[].evidences.add[].data |
String | No | |
steps[].evidences.add[].contentType |
String | No | |
steps[].evidences.add[].filename |
String | No | |
steps[].defects |
Object | No | |
steps[].defects.remove[] |
Array | No | |
steps[].defects.add[] |
Array | No | |
steps[].actualResult |
String | No | |
steps[].status |
String | No | |
status |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.