PUT /test/{testKey}/steps/{stepId}

Updates the values of an existing test step, given the test key and step id. The user can update the field values and the attachments of a step. The values should follow a specific format similar to the step creation.

- 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. A field value can be deleted sending an empty value, such as "" or [], or by sending null. It is not possible to delete the value of a required field.

Servers

Path parameters

Name Type Required Description
stepId Integer Yes

The id of the test step

testKey String Yes

Test Key

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.