👷HTTP/REST (WIP)

The HTTP/REST protocol functions are used to connect to an existing HTTP server with RESTful requests. Additionally, REST API connections are possible with the create function.

You can find them in the functions panel under Protocol Connectors -> HTTP/REST.

Create a REST API connection

With the create function you can add a REST API to the functions panel and use all the following functions without having to insert the URL again every time. Do so by dragging the functions from inside the instance from under Protocol Connectors -> HTTP/REST -> {instance name} onto the board. Remember to name your instance in the yellow box.

Add a REST API to the functions panel

Example of GET usage with pre-existing REST instance

Delete a REST API connection

To remove a REST API connection, use the delete function by inserting the name of the instance into the yellow box and triggering the function.

Removing a REST API instance

Do a GET request

With the get function you can do a simple http GET request to a server. Parameters can either be added at the end of the URL in the first box or as an object in the second box. The output is a JSON object with the HTTP header information removed.

Example GET request

The same GET request, but using the parameter input box

Do a DELETE request

Using the delete function, you can remove a resource from a server. Enter the URL of the resource you wish to delete in the input box and execute the function. DELETE requests typically don't include parameters. The output is the HTTP response in full, including header information.

Removing a resource with a DELETE request

Do a HEAD request

With the head function, you can do a HEAD request to a server, e.g. to get the content length of a GET request, without actually getting the content. Follow the same syntax as in the GET example.

HEAD request with same URL as in the GET example

Do an OPTIONS request

With the options function you can request which HTTP requests you are allowed to do on a specific resource. The allowed requests are listed under headers -> allow in the output.

Example OPTIONS request

Do a POST request

With the post function you can invoke an POST request for updating an existing resource on a server or adding a subsidiary resource to an existing one. POST is not defined as idempotent, meaning that the same request sent multiple times may have different results.

• Insert the URL, including the path on the server, into the first input box.

• Drag your data into the second input box.

You can e.g. simply drag and drop files from the file browser on the bottom left into the second input field.

Creating a new sub-resource with a POST request

Do a PUT request

With the put function you can invoke an PUT request for replacing an existing resource on a server or adding a new resource at a new path. PUT is defined as idempotent, meaning that the same request sent multiple times should have the same result, provided the server has implemented PUT correctly.

Replacing an existing resource with a PUT request

Do a PATCH request

The patch function creates a PATCH request, with which you can modify a resource on a server. PATCH requests are often omitted in the implementation of the server. You may check if it is supported with the options function.

Modifying an existing resource with a PATCH request