Response

Description

Response node is used to specify response from the request - response scenario. The request-response scenario can have multiple sinks defined in the scenario diagram.

The response body of a sink is validated against the response schema of its status code (see output schema), so different status codes can return differently-shaped responses.

Parameters and configuration

The response node configuration form contains an entry field for each "top level" item defined in the scenario output schema.

The HTTP status code advanced parameter selects the HTTP status code returned by the scenario when this sink produces the response (200 OK by default).

Besides success codes, common client error codes and some server error codes can be selected, so a negative business branch (e.g. "customer not found") can end with a sink returning 404 Not Found together with a response body. All status codes declared by the scenario's response sinks are listed in the generated OpenAPI definition of the scenario. If several sinks producing a response are reached within a single request and they declare different status codes, the default 200 OK is used.

Set the Raw editor to true if you prefer to specify the whole response as one expression. You will be able to choose validation mode in this case.