IoT Server provides real-time access to its information through API REST of a different kind
IoT Server provides real-time access to its information through API REST of a different kind:
- System Information API – general system information;
- Devices configuration API – acquisition of field devices configuration connected to the Alleantia system;
- Variables configuration API – acquisition of field devices variables configuration, plant/machine data configuration, and user-defined data;
- Data API – acquisition of actual and historical field devices variables values, plant / machine data values. Setting of field device variables values (with WRITE permission);
- Alarms API – acquisition of actual and historical alarms values configurated in the IoT Server.
All API returned data representation use the JSON format.
N.B. Suffix .json for each endpoint is void. If omitted, returned data format remains JSON
API SYSTEM INFORMATION
|
Endpoint |
HTTP Request |
|
/api/v2/info.json |
GET |
DEVICES CONFIGURATION API
|
Endpoint |
HTTP Request |
|
/api/v2/devices.json |
GET |
|
/api/v2/devices/{deviceId}/config.json |
GET |
VARIABLES CONFIGURATION API
|
Endpoint |
HTTP Request |
|
/api/v2/devices/{deviceId}/variables/config.json |
GET |
|
/api/v2/devices/{deviceId}/variables/{variableId}/config.json |
GET |
|
/api/v2/devices/custom/variables/config.json |
GET |
|
/api/v2/devices/custom/variables/{variableId}/config.json |
GET |
DATA API
|
Endpoint |
HTTP Request |
|
/api/v2/devices/{deviceId}/variables/data.json |
GET |
|
/api/v2/devices/{deviceId}/variables/{variableId}/data.json |
GET |
|
/api/v2/devices/{deviceId}/variables/{variableId}/logdata.json |
GET |
|
/api/v2/devices/{deviceId}/variables/{variableId}/set.json |
GET |
|
/api/v2/devices/custom/variables/data.json |
GET |
|
/api/v2/devices/custom/variables/{variableId}/data.json |
GET |
|
/api/v2/devices/custom/variables/{variableId}/logdata.json |
GET |
ALARMS API
|
Endpoint |
HTTP Request |
|
/api/v2/alarms |
GET |
|
/api/v2/alarms/{alarmId}/config.json |
GET |
|
/api/v2/alarms/{alarmId}/data.json |
GET |
|
/api/v2/alarms/active.json |
GET |
|
/api/v2/alarms/history.json |
GET |
Some responses include hypermedia links used to recover additional information associated to the
request. Here follows the hypermedia links structure:
- rel – relationship type as defined in RFC 5988, par. 4 “Link relation types”.
- href – address to access to recover the information associated to the link.
- type (void) – content MIME type.
- title (void) – link content description.
To find out more check the manual:
Warning: Starting from Rel. 5.2.1, REST API are not supported on port 8080. If you changed the port at installation time (see below)
and need to fix the issue, please contact our Technical Support.
If you need support don't hesistate to contact us