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

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.

  • Getting started
    Introduction to SIA Technical info Portal - Web App (UI)
  • Using SIA
    Connectors Instances Items Mapping Scripting & Variables Data
  • Connectors
    Siemens S7 Azure Ethernet/IP Mitsubishi MELSEC OPC-UA Server SQL MQTT Omron Host Link REST API Omron FINS Keyence Beckhoff TwinCAT BACnet Virtual OPC-UA Client
  • Developers
    API documentation Shadow API
  • Tutorials & Guides
    Azure IoT Hub Siemens S7 AWS IoT Core - Amazon Web Services Microsoft Power BI SIA Connect Demo Rack AVEVA Insight
+ More

Table of Contents

ParametersInstanceItem

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.
Default: None
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.
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).




Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

0
0
Expand