Request
Description
Request component defines how request - response scenario is called and the structure of data passed to it. There can be only one request node in the request - response scenario.
Parameters and configuration
| Name | Description |
|---|---|
| Method | REST Method which will be used to invoke this scenario. Does not affect the way scenario is processed. |
| Query Parameters | HTTP query parameters, as a table of fields: a name and a scalar type, an enum or a list of scalars, or the JSON Schema behind it. Click "Add field" to add one. |
| Input schema | JSON Schema defining the structure of the data passed in the HTTP request body - only if POST, PUT, PATCH method is chosen, edited as a table of fields (nested objects and lists included) or as JSON. Read here for more details about input and output schemas |
| Advanced parameters | |
| Output schema | JSON Schema defining the structure of the data returned in the HTTP response |
Sending a request from the node
Below the parameters, Send a request calls the deployed version of the scenario and shows what it answers: the HTTP
status, the time taken and the response body. The request body (for POST, PUT and PATCH) and the query
parameters (for GET and DELETE, and for a body method that declares any) start as a sample of the schemas, and
the edited request is kept in your browser; Reset to the sample builds it again. The query parameters are a JSON
object with a field per parameter, an array repeating the parameter.
The button is enabled while the scenario is running and takes the Scenario.Test permission. The request goes
through the Designer to the scenario's slug with the method of the saved scenario, and only when the saved version is
the deployed one: after a save, deploy before sending. A redirect is shown, not followed, and up to 1 MiB of the
response body is kept. A scenario that requires a
Nussknacker API token answers 401, as the Designer has no token of yours to send; call it with the cURL example of
the Integration section instead. The Designer has to be configured to reach the scenarios, see
nodesActionsHttpService.requestResponse in the Designer configuration.
Like Send Request of the HTTP Endpoint, it is shown with the node.showSendRequestButton user setting.