GET
/machines/{id}/alerts
Alerts
Become a beta tester for MachineMonitoring resources.
GET /machines /{id} /alerts
Alerts
The alerts service allows clients to retrieve the information captured on the terminal when an alert occured. For example, an alert is generated by a machine when the fuel pressure is low or there is a calibration fault in the fuel injector. Various alert types include machine, geofence, and maintenance. Response details will vary based on the alert type, which you can find in the links. For each alert, the response links to the following resources:
  • machine: View machine information.
  • alertDefinition: View the definition of the alert. Currently, this link is not followable. To view this information, embed alertDefinition in your request.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/machines/{id}/alerts
Accept application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json

 
Request Parameters
Parameter Type Example Description Default Required?
startDate dateTime 2013-04-29T00: 00:00Z Returns alerts from a specified date onward. Requests are time-based with a maximum length of seven days. 24 hours before the timestamp of the request No
endDate dateTime 2013-05-02T00: 00:00Z Returns alerts until a specific date. Requests are time-based with a maximum length of seven days. The current time of the request No
alertSeverity integer 1 Filters the alerts by severity.1 N/A No
exclude Acknowledged boolean true Excludes acknowledged alerts if "true." False No
embed string alertDefinition The only embeddable value is alertDefinition. N/A No
 
Response Details
Field Type Example Description
id string 13243546 Alert ID
time dateTime 2014-10-21T 10:32:30.000Z Time of alert.
location See sample code. See sample code. Includes latitude and longitude. Location of machine during the alert.
lat double 53.285722 Latitude
lon double 42.864666 Longitude
color string YELLOW Alert color.1
severity string MEDIUM Severity of the alert.1
acknowledgement Status string N Shows whether the alert was acknowledged. Values are "Y" or "N."
duration See sample code. See sample code. Includes "unit" and "valueAsInteger." Duration of the alert.
unit string seconds Unit of duration measurement.
valueAsInteger integer 160 The duration measurement.
occurrences integer 1 Number of times this alert has occurred.
engineHours See sample code. See sample code. Includes "links," and "reading." Engine hours of the machine during the alert.
reading See sample code. See sample code. Includes "unit," and "valueAsDouble." Engine hour reading.
links See sample code. See sample code. Links relating to the machines engine hours.
unit string hours Unit of engine hour measurement.
valueAsDouble double 1528.7333 Engine hour measurement.
machine LinearTime string 97604307 Machine's linear time during the alert.
 
Sample Response [JSON]
GET https://apicert.soa-proxy.deere.com/platform/machines/5432/engineHours
200 OK
Content-Type: application/vnd.deere.axiom.v3+json;charset=UTF-8

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/123456/alerts?contextOrganizationId=1234"
      },
      {
         "rel": "nextPage",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/123456/alerts;start=10;count=10?contextOrganizationId=1234"
      }
   ],
   "total": 2,
   "values": [
      {
         "links": [
            {
               "rel": "machine",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/123456"
            },
            {
               "rel": "alertDefinition",
               "uri": "https://mamosservices.deere.com/api/alertTypes/diagnosticTroubleCodeAlert/definitions/987654"
            },
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/alerts/MTQ2NTI3LWRpYWdub3N0aWNU"
            }
         ],
         "id": "13243546",
         "time": "2014-10-21T10:32:30.000Z",
         "location": {
            "links": [],
            "lat": 53.28572,
            "lon": 42.864666
         },
         "color": "YELLOW",
         "severity": "MEDIUM",
         "acknowledgementStatus": "N",
         "duration": {
            "links": [],
            "unit": "Seconds",
            "valueAsInteger": 160
         },
         "occurrences": 1,
         "engineHours": {
            "links": [],
            "reading": {
               "links": [],
               "unit": "Hours",
               "valueAsDouble": 1528.7333
            }
         },
         "machineLinearTime": 97604307
      }
   ]
}
 
[1] Alert Colors & Severity
Color Severity
RED HIGH
YELLOW MEDIUM
GREEN LOW
GRAY INFO
GRAY DTC
GRAY UNKNOWN