MSA Grid RESTful API, Руководство для стартапов

Страница: 22 / 53

Install OpenVPN Client
Grid RESTful API Start-up Guide 22
2.3.5 Device Type: BACnet IoT Gateway
Please note that this product makes use of a device API version - see Section 3.1.2 .
•
Product versions below "4.0.0" do not have a device API version and can be assumed to support
“
deviceAPIVersion
”
1. Version 1 requests may specify this parameter.
•
Product version "4.0.0" supports only
“
deviceAPIVersion
”
2. Version 2 requests must specify this
parameter.
GetDeviceData (v.1, v.2)
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.
A query can narrow the entire data set down by:
•
selecting only certain gateway devices (e.g. gateways reporting an Alarm state), using the
deviceFilter parameter.
•
selecting only certain downstream devices within the selected gateway devices (e.g. those
reporting an Alarm status), using the
dataFilter parameter.
•
selecting only certain data paths to be read from the selected downstream devices, using the
path parameter.
Parameters:
•
happn_token
– token obtained from the login request.
•
deviceAPIVersion
– see
Section 2.3.5 .
•
IIoT device selector (optional)
– one of two ways of specifying the target IIoT device(s):
o
deviceID
– the IIoT gateway ID (see
Section 3.1.1 )
o
deviceFilter
– MongoDB-style query object (see
https://www.npmjs.com/package/sift
); this
option can only be specified by posting parameters in a JSON payload
If no gateway device selection criteria are given, all gateways are queried. Use with care! Not
specifying IIoT device(s) will cause requests to be sent to all IIoT devices!
•
path (optional)
o
either a path string, pointing to a value within each downstream field device (boiler) object,
e.g. "propertyName/subPropertyName
"
o
or an array of such path strings, e.g. ["propertyName_1/subPropertyName_1
",
"
propertyName_2/subPropertyName_2
"]
o
note that any unmatched path value is simply ignored and left out of the result
o
if no path is specified, all available values are returned
•
options (optional)
– an optional object containing:
o
dataFilter
– a MongoDB-style sift query object (see
https://www.npmjs.com/package/sift
); result
objects relating to downstream field devices are only included in the response if they match
this filter