REST API - Instance & item setup
How to setup a REST API instance and item in SIA
The REST API SIA connector allows for performing HTTP(s) REST API calls with a remote server.
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). |