MSA Grid RESTful API Startup Manual page 32

CallDeviceMethod – GetBACnetPropertyValue (v.1, v.2)
Description: Get BACnet property value by sending a 'readProperty' request out on BACnet.
Device API Changes: In v2 responses are formatted according to ANSI/ASHRAE Standard
135-2016 (minor changes including property name changes and case changes) instead of
ANSI/ASHRAE Standard 135-2012 in v1.
HTTP Verb: GET or POST
URL:
/rest/method/fieldpop-api/callDeviceMethod
Parameters:
•
happn_token – token obtained from the login request.
•
deviceAPIVersion – see Section 2.3.5.
•
deviceID – the IIoT gateway ID (see Section 3.1.1).
•
methodName –
getBACnetPropertyValue
"
•
deviceInstance – the BACnet device instance.
•
objectType – the BACnet object type.
•
objectInstance – the BACnet object instance.
•
propertyIdentifier – the BACnet property identifier.
Example – URL: (HTTP POST)
/rest/method/fieldpop-api/callDeviceMethod?happn_token=eyJ0eXAiOiJKV1QiLC
Example – JSON body:
{
"parameters": {
"deviceID": "gateway_1",
"deviceAPIVersion": "2",
"methodName": "getBACnetPropertyValue",
"deviceInstance": 200,
"objectType": "analog-value",
"objectInstance": 0,
"propertyIdentifier": "present-value"
}
}
Example – JSON Response:
{
"message": "Call successful",
"data": {
"value": 27,
"type": "REAL"
},
"error": null
}
"
Grid RESTful API Start-up Guide
Install OpenVPN Client
32