April 2019 (version 2.25/2.25.1)
The Remote Manager April 2019 releases contain the following features:
v2.25
- Device names
- Alarm type: Datapoint on Change
- API Explorer layout changes
- New APIs
- Filtering and Sorting in the v1 APIs
- Tutorials: Azure and AWS
v2.25.1
- Allow multiple versions in SCI Firmware Update
- API for alert history by alert source
- Support for relative times in API paramters and queries
- Reports based on devices queries
Device names
In addition to the required device ID, you can optionally assign a unique name to each device. The name appears in the device list, on pins in the map view, and in alarm email notifications.
A device name can be from 1 to 63 characters. Valid characters are ASCII letters from a to z, the digits from 0 to 9, and the hyphen (-). The name may not start with a hyphen.
Alarm type: Datapoint on Change
You can trigger an alarm based on the value of a Datapoint change. This is useful to notice changes such as the active wan, IP address, or cellular technology.
API Explorer layout changes
API Documentation, Response, and Request content are displayed in tabs within the lower right panel of the API Explorer:
New APIs
| API | Methods | Change |
|---|---|---|
|
/v1/alerts/summary /v1/alerts/status |
GET |
New API to get the status of alerts. Status is a subset of the data in summary. |
|
/v1/groups |
GET POST PUT DELETE |
New API to get, add, move, and delete groups. Allows devices to be moved to a parent group on delete. |
|
/v1/devices/inventory /v1/devices/bulk |
Added fields including the number of fired alarms and cellular related data. Add or update devices using a CSV format Get devices in a CSV format. | |
| /v1/reports | Many additional reports. | |
| sci | Available to read only users - limited to operations that do not modify the device Update firmware from the firmware repository specifying a version. | |
| Monitor |
Allow authorization header. New monitor topics: devices and alert_status |
Filtering and Sorting in the v1 APIs
Filtering and sorting have been enhanced in the v1 APIs.
Here are some examples:
/ws/v1/devices/inventory?query=tags='fileUpdate'&orderby=connection_status
Get a list of devices that have been tagged with fileUpdate and return them sorted by the connection status.
/ws/v1/devices/inventory?query=group startsWith 'Minnesota'
Get a list of devices that are in the Minnesota group including all child groups.
/ws/v1/alerts/summary?query=status='fired'&orderby=last_update desc
Get a list of all alerts in the fired state and order with most recently fired first.
Tutorials: Azure and AWS
Added two tutorials:
Azure: https://www.digi.com/resources/documentation/digidocs/90002345/default.htm
AWS: https://www.digi.com/resources/documentation/digidocs/90002346/default.htm
Allow multiple versions in SCI Firmware Update
To update firmware for many devices in a single SCI request, specify the vendor ID and/or device type for each version. Match a device against vendor ID and device type first, then vendor ID, then use the version with no qualifiers.
Device type specified
<sci_request version="1.0">
<update_firmware>
<targets>
<group path="my_group"/>
</targets>
<version>3.0.0.0</version>
<version deviceType="TransPort LR54">3.0.0.1</version>
<version deviceType="TransPort LR54W">3.0.0.2</version>
<version deviceType="TransPort WR64">3.0.0.3</version>
</update_firmware>
</sci_request>Specify vendor ID and device type
<sci_request version="1.0">
<update_firmware>
<targets>
<group path="my_group"/>
</targets>
<version vendorId="FE000009" deviceType="TransPort LR54">3.0.0.1</version>
<version vendorId="FE000009" deviceType="TransPort LR54W">3.0.0.2</version>
</update_firmware>
</sci_request>Specify device type with vendor ID fall back
<sci_request version="1.0">
<update_firmware>
<targets>
<group path="my_group"/>
</targets>
<version deviceType="TransPort LR54">3.0.0.1</version>
<version vendorId="FE000008">3.0.0.2</version>
</update_firmware>
</sci_request>
API for alert history by alert source
The v1/alerts/history/alert[/source] API shows an historical status view of an alert by id or name. The alert history records each status change of an alert. See the API Explorer for examples.
Support for relative times in API paramters and queries
Added support for specifying relative time values in the start and end time parameters and query parameters:
- For the start_time/end_time parameters in v1 API /ws/v1/*
- For the startTime/endTime parameters in legacy API /ws/*
- For the query parameter on /ws/v1/devices/inventory specifically the last_connect, last_disconnect and last_update fields
- For the query parameters on /ws/v1/alerts/status and /ws/v1/alerts/summary specifically the last_update
Reports based on devices queries
Added API to generate reports based on devices queries. See /ws/v1/reports/devices in the API Explorer for details.
PDF
