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
  1. Build & Deploy Apps
  2. Integrations
  3. Protocol Connectors

GraphQL

Last updated 7 months ago

GraphQL is a query language for APIs that provides a more efficient and flexible alternative to REST. It allows clients to request only the data they need and nothing more, streamlining interactions between the client and server. This results in potentially reduced traffic and server load.

Do a GraphQL transaction

Using the request function, you can do a transaction on an existing GraphQL API.

There are multiple parameters at play for this request:

Parameter
Type
Description

url

String

The GraphQL API endpoint.

document

String

Your GraphQL request. Either a query or a mutation in GraphQL notation.

variables

Object

Optionally provide variables with this parameter.

headers

Object

Any header key-value pairs (e.g. for authorization).

  1. Insert the URL to the GraphQL API endpoint into the first field.

  2. Insert the GraphQL query in the second field, including the query { ... } part.

  3. Optionally add variables or headers in the third and fourth input fields.

The variables field can be used to e.g. dynamically insert variables into the query.

The headers field can be used e.g. to add authorization info or declare which return type (e.g. json) the query should have, if supported by the endpoint.

To make requests with special characters, you need to declare the whole document input as text as described in Data processing -> Functions ->

Inputs
Example for doing a GraphQL request