On HTTP Route
Last updated
Last updated
On HTTP Route is an Event Listener Node that executes when a Request is received by a specific Route, which is set up in the Attributes, and returns the data defined by the outputs. A Route is made up of a Method and URL.
The Node changes with each Route added. Please refer to the example for more information.
Scope: Project, Scene.
Configuration
Drop-down
The desired HTTP server, which refers back to the selections made under HTTP in the Project Settings.
Routes
Add Elements
A Route is made up of its HTTP Method (either GET, POST, DELETE, PUT, or HEAD) and its URL.
Is Body Binary
Bool
The user chooses true or false depending on whether they wish for the Body output to remain a String or be converted into binary. This Attribute is only available for the Methods POST, PUT, and DELETE.
path/name (METHOD) (►)
Output Pulse
An Output Pulse which appears when a Route is created and a Method is chosen. It executes when a Request is received by the Route. Since it is possible to have multiple Routes, it is possible to have multiple Output Pulses.
Headers
Dictionary
HTTP headers in the form of key/value pairs.
Query
Dictionary
Parameters of the call in the form of key/value pairs.
Body
String
The body of the response, usually including HTML text. This Attribute is only available for the Methods POST, PUT, and DELETE.
To better demonstrate the differences between the Methods and how that translates to changes in the Node, please refer to the following image:
Every Methodcreates a new Output Pulse for that specific Method, along with the provided URL given in the Attributes section. If there are multiple Methods, some Outputs are shared. These are Headers, Query, and Request ID, which appear at the bottom of the Node. For the Methods that return the String Output Body, a separate Body Output is created for each.
Different HTTP Methods on W3Schools.
