Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Home
  • Knowledge base
  • Contact Us
  • Home
  • Connectors
  • REST API

REST API - Instance & item setup

How to setup a REST API instance and item in SIA

Written by Ioannis Panteleakis

Updated at December 22nd, 2023

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Installation & Technical information
    Introduction SIA Connect Standalone SIA Connect ANY-Ware Cellular & WiFi connectivity
  • Configuration in the Web UI
    Getting started with the UI Connectors Instances Items Mapping Data System Network Tools & Add-ons DigiCert IoT Trust Manager
  • Connectors
    Siemens S7 Azure IoT Ethernet/IP Mitsubishi MELSEC OPC-UA Server SQL MQTT Omron Host Link REST API Omron FINS Keyence Beckhoff TwinCAT BACnet Virtual OPC-UA Client MS SQL File M-Bus Modbus
  • Scripting & Variables
    Data formatting
  • Developers
    API documentation Shadow API
  • Tutorials & Guides
    InfluxDB AWS IoT Core - Amazon Web Services Microsoft Power BI KaaIoT Siemens S7 AVEVA Insight SIA Connect Demo Rack Grafana Azure
  • General
+ More

Table of Contents

HTTP & HTTPS Parameters Instance Item

The REST API SIA connector allows for performing HTTP(s) REST API calls with a remote server.

 

HTTP & HTTPS

The Connector supports both HTTP and HTTPS (secure) connections.

 

 

Parameters

When using the REST API Connector both the instance and item have specific parameters. These parameters are required as they are needed to establish a connection and to connect to a specific endpoint.

 

Instance

The instance needs the following parameters to establish a connection to the remote server:

Parameter Description
Address (instance default) The IP address or URL of the server to connect to.
Timeout
 
The amount of time to wait for a response from the remote server, before considering it a failed connection.
Default: 10
 Default Headers
 

The parameters to be passed to the headers of the request.

{Authorization: Basic <credentials>}{"contentEncoding": "UTF-8"}
Json
 
Whether the request is a JSON type that will be added to the default headers.
Default: Yes
 

 

Item

The item parameters that are needed to read the connect to a remote server:

Parameter Description
Endpoint
 
The endpoint for a specific request.
 
Header
 

Additional header settings to be added to the HTTP request. To add multiple headers use the format as below:

{Authorization: Basic <credentials>}{"contentEncoding": "UTF-8"}
Type
 
The request type to use (POST, PUT, GET, DELETE).
 
Body
 
Optional request data to add to the specific request as the default payload (eg. login information).
 

 

 

api restful

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Validating data exchange between AWS IoT Core and PLC
  • Bulking multiple data items into a JSON message

0
0
Expand