Troubleshooting
Grid RESTful API Start-up Guide
43
3
Additional Information
3.1
General Notes
3.1.1 How to Obtain an IIoT Device ID (DeviceID Parameter V alue)
This can be obtained from:
•
LAN access to the local Grid GUI on the device (e.g. http://192.168.1.20/fieldpop/client/).
•
Grid tunnel access to the Grid GUI on the device.
•
From the Grid website, by clicking on the device pin on the Device Management map.
3.1.2 Device API Version
The API available to communicate directly to a device is versioned by the
"
deviceAPIVersion
"
parameter.
A device may support multiple device API versions at once (e.g. version 1 and 2 being supported). The
highest supported device API versions on the device is specified as an array of semver formatted strings,
e.g.
["1.2.3", "2.3.4"]
– it can be obtained by:
•
Viewing the “About” page on the device.
•
Doing a
getUserDevices
request
– under the
“
packageInfo
”
property of the response per device
–
see
Section
The desired
"
deviceAPIVersion
"
should be specified as part of the request:
•
Example:
/rest/method/fieldpop-api/getDeviceData?happn_token=eyJ0eXAiOiJKV1QiLC&deviceAPIVersion=2
•
If JSON body parameters are used in the request, then deviceAPIVersion should also specified in
the JSON body, and not as a query parameter as shown in the example.
•
If not specified, request version 1 is assumed.
•
If deviceAPIVersion=2 is specified, the requests will only be sent to devices with supported
versions greater than or equal to 2 and less than 3.
•
If deviceAPIVersion=2.3 is specified, the requests will only be sent to devices with supported
versions greater than or equal to 2.3 and less than 3.
•
If deviceAPIVersion=2.3.4 is specified, the requests will only be sent to devices with supported
versions greater than or equal to 2.3.4 and less than 3.
3.1.3 Data Retention
The RESTful API will provide access to all data retained on the Grid. The duration for which data is retained
on the Grid is an operation decision outside the scope of this document.
3.1.4 Data Structure
All data will be returned in a self-describing JSON format.
