Eliona
English
English
  • Overview
  • Guides
    • 🚀Right, let's get started!
    • Login
    • Set up a Project
    • Create User
    • Create and assign project roles
    • Add Asset
    • Create Custom Widgets
    • Add Rules
    • Install the Eliona App
    • Add BIM
    • Add Smart Assist view
    • Create a Digital Twin
    • White Labeling in Eliona
    • Image to Alarm
    • Suppressing Messages
    • Configure a meter change
    • Utilize QR-Code
    • How the “Wayfinding” works
  • Manuals
    • User Interface
    • Dashboard
      • Widget Block List
    • Alarms
    • Ticket Management
    • Rule Engine
    • Asset Management
    • Analytics & Reports
    • Smart Assist
      • SmartAssist View
      • Smart Assist Elements
    • Map
    • BIM
    • Digital Twin
    • Connection
      • MQTT
      • Webhook
      • RESTful
      • Kafka
      • OPC UA
      • Legacy
      • Format
      • Functions
    • Settings
      • Apps
        • Asset Filter
      • Templates
      • Script Engine
      • Audit Trail
      • Licence
      • System
    • Eliona Engineering
      • Users
      • Roles
      • Projects
      • Tag Management
      • Notifications Providers
      • Escalation
      • Assets Modeling
        • Asset template library
      • Asset Editor
    • Monitoring
    • Augmented Reality
    • Bookmarks
    • Notifications
  • ELIONA APPS
    • Apps
      • ABB Free@Home
      • Akenza
      • Booking
      • CoffeeCloud
      • Device Simulator
      • Exchange app
      • Glutz
      • GP Joule
      • Hailo
      • Kentix
      • KentixOne
      • Kontakt.io
      • Localino
      • Microsoft 365
      • Microsoft ADFS
      • Loriot.io
      • Niagara
      • myStrom App
      • OpenBOS
      • Renzbox
      • ROOMZ
      • SAML SSO
      • Signify
      • SpreadSheet
      • Stopwatch
      • Thingdust
      • Xovis
      • Xovis People Counter
      • Zevvy
    • Integrations
      • Niagara Module
    • App SDK
  • REFERENCES
    • Rest API
    • Engineering
  • Support Center
    • Changelog
    • FAQ
    • Service Desk
Powered by GitBook
On this page
  • RESTful overview
  • Connection Configuration
  • Request Configuration
  • Parameters
  • Headers
  • Authorization
  • Body
  1. Manuals
  2. Connection

RESTful

Content of the chapter: Configuration of RESTful

PreviousWebhookNextKafka

Last updated 1 year ago

The RESTful feature is used in Eliona to link online data with . For example, it can be used to get data from the API.

RESTful overview

  1. Name: Name of the connection.

  2. URL: Shows the URLs of connections.

  3. Requests: Shows the number of requests of connections.

  4. Search function: Search for connections.

  5. Sort: Sort the connections by status, name or URL.

  6. Configure Connection: Click the arrow to configure the connection.

  7. Name: Name of the linked request

  8. Method: Shows the HTTP-Method of the request.

  9. Endpoint: Displays the URL for the endpoint.

  10. Interval: Indicates the configured time interval.

  11. Configure request: Click the arrow to configure the request.

Connection Configuration

  1. Pause/enable connection: Click to pause a connection and click to activate the connection.

  2. Name: Enter the name of the connection.

  3. Base URL: Enter the base URL

  4. Authentication: Choose between No Authentication, Basic Authentication, API Key and Bearer Token.

  5. Host: Enter the host.

  6. Port: Enter the port.

  7. Username: Enter your login username.

  8. Password: Enter your password.

  9. Create/Cancel: Click Create to keep the changes.

  10. Requests: List of all existing requests.

  11. Search: Search existing requests from the list.

  12. Sort: Sort requests by name, method, format, endpoint, or interval.

  13. Request: Click to create a request.

Request Configuration

  1. Test request: Click to test the request and get a report of the test.

  2. Name: Name the request.

  3. Path: Enter the URL address.

  4. Interval: Interval in seconds.

  5. HTTP Method: Select the request method.

  6. Format: Select a format for the request.

  7. Create Format: Create a new format.

  8. Request Editor: Select between Parameters, Headers, Authorization and Body.

  9. Create Parameters: Click to create new parameters.

  10. Save/Cancel: Click Save or Cancel to keep or discard the changes.

Parameters

Enter the key and value and click the check mark.

Headers

Enter the key and value and click the check mark.

Authorization

Select the authentication between No Authentication, Basic Authentication, API Key and Bearer Token.

Body

Body editor allows you to define the message body to be sent to the API.

Pause/enable connection: Click to pause or to enable the connection.

Create connection: Click to create a new connection.

Add request: Click to create a request.

Remove Connection: Click to delete the connection.

Remove request: click to remove the request.

formats
openweathermap
Connection configuration
Request Configuration
Parameter Configuration
Authorization Configuration
Body Configuration