Grid RESTful API Supported Functions
Grid RESTful API Start-up Guide
13
"error": {
"message": "Unknown field device:
BAC_IP_Falcon_Hydronic_1_"
}
},
{
"data": "BAC_IP_Falcon_Steam"
},
{
"data": 1
},
{
"error": {
"message": "Unknown property for device
BAC_IP_Falcon_Steam_2_:
INLETWATERTEMPDEGF"
}
}
]
},
"crackfisher_N1-": {
"error": {
"message": "timeout"
}
},
"hurricanestone_NkvQCitk-": {
"error": {
"message": "timeout"
}
},
"tulipgorilla_EyGpqsFkb": {
"error": {
"message": "timeout"
}
}
},
"error": null
}
GetDeviceData (System View v.4)
Description:
Retrieve the data available under the specified device(s) and data path(s).
HTTP Verb:
GET or POST
URL:
/rest/method/fieldpop-api/getDeviceData
Data Model:
The underlying data is structured as an object keyed by IIoT gateway identifier
(deviceID) values at the top level. Each gateway value is an array of downstream field device objects.
Here is a schematic example of the full available data for a given user.
{
"gateway_1": {
"data": [
{
"parameters": {
"node_id": "1"
},
"type": "BAC_IP_Falcon_Hydronic",
"mapping": "BAC_IP_Falcon_Hydronic",
"name": "BAC_IP_Falcon_Hydronic_1_",
"path":
"/profileView/devices/BAC_IP_Falcon_Hydronic_1_",
"node": "Dev_1",
"events": {
"alarm": false,
"trouble": false,
"warning": false
},
"activeEvents": {},
"address": "1",
"location": "R&D Lab Unit 1",
"status_class": "status_normal",
"status": "Normal",
"oldStatus": "Normal",
"BOILERLEADLAGSETPOINTDEGC": 58.9
},
{
"parameters": {
"node_id": "2"
},
"type": "BAC_IP_Falcon_Steam",
"mapping": "BAC_IP_Falcon_Steam",
"name": "BAC_IP_Falcon_Steam_2_",
"path":
"/profileView/devices/BAC_IP_Falcon_Steam_2_",
"node": "Dev_2",
"events": {
"alarm": false,
"trouble": false,
"warning": false
},
"activeEvents": {},
"address": "2",
"status_class": "status_normal",
"status": "Normal",
"oldStatus": "Normal",
"BURNER_ENABLE": 1
}
]
},
"gateway_2": {
"data": [
{
"parameters": {
"node_id": "1"
},
"type": "BAC_IP_Falcon_Hydronic",
"mapping": "BAC_IP_Falcon_Hydronic",
"name": "BAC_IP_Falcon_Hydronic_1_",
"path":
"/profileView/devices/BAC_IP_Falcon_Hydronic_1_",
"node": "Dev_1",
"events": {
"alarm": false,
"trouble": false,
"warning": false
},
