Grid RESTful API Supported Functions
Grid RESTful API Start-up Guide
11
"parameters": {
"node_id": "3",
"parameter1": "2",
"parameter2": "1"
},
"type": "Device2",
"mapping": "Device2",
"name": "Device_2_Profile_1",
"path": "/profileView/devices/Device_2_Profile_1",
"events": {
"alarm": false,
"trouble": false,
"warning": false
},
"activeEvents": {},
"status_class": "status_normal",
"status": "Normal",
"oldStatus": "Normal",
"property0": 1
},
"Device_2_Profile_2": {
"parameters": {
"node_id": "4",
"parameter1": "2",
"parameter2": "2"
},
"type": "Device2",
"mapping": "Device2",
"name": "Device_2_Profile_2",
"path": "/profileView/devices/Device_2_Profile_2",
"events": {
"alarm": false,
"trouble": false,
"warning": false
},
"activeEvents": {},
"status_class": "status_normal",
"status": "Normal",
"oldStatus": "Normal",
"property0": 2
}
},
"error": null
}
Example JSON Response:
(path = Device_1_Profile_1)
{
"message": "Call successful",
"data": {
"parameters": {
"node_id": "1",
"parameter1": "1",
"parameter2": "1"
},
"type": "Device1",
"mapping": "Device1",
"name": "Device_1_Profile_1",
"path": "/profileView/devices/Device_1_Profile_1",
"node": "Dev_1_1",
"events": {
"alarm": false,
"trouble": false,
"warning": false
},
"activeEvents": {},
"status_class": "status_normal",
"status": "Normal",
"oldStatus": "Normal",
"property0": 1,
"property1": 1,
"alarm_property": 0,
"trouble_property": 0
},
"error": null
}
Example JSON Response:
(path = Device_1_Profile_1/property0)
{
"message": "Call successful",
"data": 1,
"error": null
}
Example POST URL:
/rest/method/fieldpop-api/getDeviceData?happn_token=eyJ0eXAiOiJKV1QiLCJhbGci
Example POST Payload:
(array of paths)
{
"parameters": {
"deviceFilter": {
"$ne": "Normal"
},
"path": [
"BAC_IP_Falcon_Hydronic_1_/type",
"BAC_IP_Falcon_Hydronic_1_/BURN_CTL_
STATUS",
"BAC_IP_Falcon_Hydronic_1_/
INLETWATERTEMPDEGF",
"BAC_IP_Falcon_Steam_2_/type",