POST /test/{testKey}/steps
Create a new test step. All step fields values are listed under fields and identified by the name and a list of attachments to add to the step. The field values should follow a certain format according to the 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".
The remaining field types values do not required a specific validation. For instance, for a Single Line Custom field a valid value would be "Perform Action B".
If some value is not valid for a certain custom field type, an error will be return stating the field with the incorrect value. Furthermore, all required step fields must be provided.
Servers
- https://sandbox.xpand-it.com/rest/raven/2.0/api
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
testKey |
String | Yes |
The key of the test issue, e.g., CALC-562 |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
testVersion |
String | Yes |
A test version, e.g., manual_2 |
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.