Heisenware Docs
Go to websiteGet a demo
  • 👋Welcome
  • Getting started
  • Release Notes
    • v84 - Get in the flow
    • v83 - Beauty treatment
    • v82 — Fully distributed
    • v81 — Removing old cruft
    • v80 — Chicks on fire
    • v79 — Nothing is forever
    • v78 — Keep moving
    • v77 — More intelligence
    • v76 — Well cooked
  • Build & Deploy Apps
    • Overview
    • Flow Builder
      • Nodes (Functions)
        • Inputs
        • Trigger
        • Output
      • Function Extensions
        • Modifier
        • Filter
        • Error handler
        • Memorizer
      • Objects & Instances
      • Utilities
        • Basic Functions
        • PDF functions
        • Circular buffer
        • Timer
        • Counter
    • Integrations
      • Protocol Connectors
        • GraphQL
        • HTTP/REST
        • MQTT
        • OPC UA
          • Heidenhain PLCs with OPC UA
        • RS-232/485
        • Siemens S7
      • Data Connectors
        • File
        • Relational Database
        • Time Series Database (WIP)
      • API Connectors
        • OGC SensorThings API
        • Operating System
        • Zebra RFID IoT Connector
      • Agent / (Edge Connector)
      • Calling Custom Code
    • UI Builder
      • Input Widgets
        • Form
        • File Upload
        • Photo
        • Signature
        • Barcode / QR-Code (WIP)
        • Document Scan (WIP)
      • Display Widgets
        • Chart
        • Chat
        • Circular Gauge
        • Data Grid
        • Linear Gauge
        • Map
        • Media View
        • Progress Bar
        • Sparkline
        • Status Lamp
        • Toast
        • Value Box
        • Kanban Board
        • Data Tiles
        • Pie Chart
        • Sankey
      • Buttons
      • Text Box
      • Images
      • Icons
    • Communication Interfaces
      • Email Notifications
      • OPC UA Server
    • Data & File Storage
      • Internal InfluxDB
      • Internal PostgreSQL
      • File Server
    • App Appearance
      • Pages
      • In-App Navigation
      • Screens & Devices
      • Theming
    • Simulation & Testing
      • Simulating Events
      • Simulating Data
    • PDF Templates
    • RAG-based Chatbot
    • Deployment
  • Manage Apps
    • Overview
    • Manage Apps
      • General Settings
      • Users and Access
      • Distribution & Versioning
    • Manage Integrations
    • Manage Account
      • Account Structure
      • Members
      • Workspaces
  • TUTORIALS
    • Build Your First Heisenware App
  • Connect Heidenhain CNC with OPC UA Support
  • Related links
    • Website
    • Privacy policy
    • Imprint
Powered by GitBook
On this page
  • REST API instance
  • Create a REST API connection
  • Delete a REST API connection
  • RESTful server requests
  • Do a GET request
  • Do a DELETE request
  • Do a HEAD request
  • Do an OPTIONS request
  • Do a POST request
  • Do a PUT request
  • Do a PATCH request
  1. Build & Deploy Apps
  2. Integrations
  3. Protocol Connectors

HTTP/REST

Last updated 12 months ago

To integrate data from HTTP/REST servers exposed to the internet, you can establish a connection with a REST API. To start, navigate to Protocol Connectors in the functions panel and unfold HTTP/REST.

To integrate a server from a local network, you need to deploy an HTTP/REST first. Afterward, you can use the same functions described in this article.

REST API instance

If a REST API is to be integrated and your app needs to repeatedly access this API using different types of requests or resources, it is recommended to create an instance for this connection to avoid re-entering the URL every time.

Create a REST API connection

With the create function, you can add a fixed REST API connection instance and use all the below. Do so by using and configuring the create function. Remember to name your instance in the yellow naming box.

The connection instance will appear in the functions panel. After that, you can use the functions from inside the instance from under Protocol Connectors -> HTTP/REST -> {instance name} by dragging them onto the board.

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.

RESTful server requests

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 input box or as an object in the second input box. The output is a JSON object with the HTTP header information removed.

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.

Do a HEAD request

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.

Do a POST request

With the post function, you can invoke a 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 server path, into the first input box.

  • Drag your data into the second input box.

You can also drag and drop files from the file manager on the bottom left into the second input field.

Do a PUT request

With the put function, you can invoke a 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.

Do a PATCH request

The functions are used to connect to an existing HTTP server with RESTful requests. All these functions are also available within a connection instance, specifically created for a connected REST API.

With the head function, you can do a 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 example.

The patch function creates a 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 function.

HTTP/REST protocol
HEAD
GET
PATCH
options
edge connector
RESTful server request functions
Add a REST API to the functions panel
Example of usage with pre-existing REST instance
Removing a REST API instance
Example GET request
The same GET request, but using the parameter input box
Removing a resource with a DELETE request
HEAD request with same URL as in the GET example
Example OPTIONS request
Creating a new sub-resource with a POST request
Replacing an existing resource with a PUT request
Modifying an existing resource with a PATCH request
GET