GET
/organizations/{orgId}/machines
List Machines
GET
/machines/{machineId}
View A Machine's Info
GET
/machines/{machineId}/locations
List Machine Locations
POST
/machines/{machineId}/ping
Post Machine Ping
The term “machine” in the context of this API refers to any machine connected with an MTG or UTG with a JDLink license, or a non-telematic machine that has been manually entered into Operations Center by a user. Machines can be tractors, combines, etc. that perform field work, or they can also refer to construction machines, such as excavators, loaders, and more.
GET /organizations /{orgId} /machines
List Machines
This resource allows the client to view a list of a user's telematically enabled machines. If the user is a dealer, they will be able to view their own machines and their customers' machines. If the user is not a dealer, they will be able to view all the machines within all their MyJohnDeere organizations.
 
Code Loop
This is the code loop your application should follow to get the machine list:
  1. Call the API Catalog.
  2. Call the organizations list.
  3. Call /organizations/{orgId}/machines for the organizations returned.
 
For each machine listed, the response contains links to the following resources:
  • organizations: View the organization to which the machine belongs.
  • maintenancePlans: View the machine's maintenance plans.
  • locations: View the machine's locations.
  • terminals: View the machine's terminals. This link is currently unfollowable; this information can also be embedded in the request.
  • displays: View the displays on this machine. This information can also be embedded in the request.
  • measurements: View machine measurements.
  • lastKnownEngineHours: View the machine's last known engine hours.
  • alerts: View the machine's alerts.
  • measurements: View machine measurements.
  • hoursOfOperation: View the machine's hours of operation.
  • distanceTraveled: View the machine's distance traveled.
  • deviceStateReports: View the machine's device state reports.
  • engineHours: View the machine's engine hours.
  • locationHistory: View the machine's location history.
  • workAssignments: View the machine's work assignments.
  • offsets: View the machine's offsets.
  • capabilities: Lists machine hardware and software licenses. This information can also be embedded in the request.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/organizations/{orgId}/machines
Accept: application/vnd.deere.axiom.v3+json
 
Request Parameters
Parameter Type Example Description Default Required?
capability string wdt Filters responses by the specified machine capability. N/A No
embed string terminals Takes these values: terminals, categories, capabilities, displays.
Separate multiple embeds with commas.
N/A No
 
Response Details
Field Type Example Description
@type string Machine Object Type. Only appears in JSON responses.
visualizationCategory string tractorUtility The category image for the given machine.
machineCategories --- See sample response below. Includes make, model, type, and DMC information.
category --- See sample response below. Machine category. Includes @type, name, ID, and type.
make --- See sample response below. Machine make. Includes @type, name, ID, and type.
model --- See sample response below. Machine model. Includes @type, name, ID, and type.
detailMachineCode --- See sample response below. Detail machine code. Includes @type, name, ID, and type.
name string 8270R Name of value.
id string 754592 Type ID.
type string model Type of value.
productKey string 42997112 Machine product key.
engineSerialNumber string RG6090L839275 Machine's engine serial number.
telematicsState string active Indicates whether the machine is telematically active.
capabilities --- See sample response below. Machine capabilities.
terminals --- See sample response below. List of terminals attached to this machine. Includes @type and otherAttributes.
displays --- See sample response below. List of displays in this machine. Includes @type and otherAttributes.
GUID string b2b69591-b502-8k25-8253-e7760c1e524e Machine GUID.
modelYear string 2010 Machine model year.
id string 8187 Machine ID.
vin string 1L06215RJDR782108 The VIN of the machine.
name string 1L06215RJDR782108 The name of the machine.
 
Sample Response in JSON
200 OK
Content-Type: application/vnd.deere.axiom.v3+json;charset=UTF-8

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/machines"
      },
      {
         "rel": "nextPage",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/machines;start=10;count=10"
      }
   ],
   "total": 1,
   "values": [
      {
         "@type": "Machine",
         "visualizationCategory": "tractorUtility",
         "machineCategories": {
            "@type": "MachineCategories",
            "machineCategories": [
               {
                  "@type": "MachineCategory",
                  "name": "JOHN DEERE",
                  "id": "1",
                  "type": "Make"
               },
               {
                  "@type": "MachineCategory",
                  "name": "8270R",
                  "id": "754592",
                  "type": "Model"
               },
               {
                  "@type": "MachineCategory",
                  "name": "Tractor",
                  "id": "1012",
                  "type": "Type"
               },
               {
                  "@type": "MachineCategory",
                  "name": "RW73262",
                  "type": "DMC"
               }
            ],
            "otherAttributes": {}
         },
         "category": {
            "@type": "MachineCategory",
            "name": "Tractor",
            "id": "1012",
            "type": "Type"
         },
         "make": {
            "@type": "MachineCategory",
            "name": "JOHN DEERE",
            "id": "1",
            "type": "Make"
         },
         "model": {
            "@type": "MachineCategory",
            "name": "8270R",
            "id": "754592",
            "type": "Model"
         },
         "detailMachineCode": {
            "@type": "MachineCategory",
            "name": "RW83823",
            "type": "DMC"
         },
         "productKey": "42997112",
         "engineSerialNumber": "RG6090L839275",
         "telematicsState": "active",
         "capabilities": [],
         "terminals": {
            "@type": "Terminals",
            "otherAttributes": {}
         },
         "displays": {
            "@type": "Displays",
            "otherAttributes": {}
         },
         "GUID": "b2b69591-b502-8k25-8253-e7760c1e524e",
         "modelYear": "2010",
         "id": "8187",
         "vin": "1RW8270RPAP012934",
         "name": "RW8270R011856",
         "links": [
            {
               "@type": "Link",
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432"
            },
            {
               "@type": "Link",
               "rel": "organizations",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            },
            {
               "@type": "Link",
               "rel": "maintenancePlans",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432/maintenancePlans"
            },
            {
               "@type": "Link",
               "rel": "locations",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432/location"
            },
            {
               "@type": "Link",
               "rel": "terminals",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432/terminals"
            },
            {
               "@type": "Link",
               "rel": "displays",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432/displays"
            },
            {
               "@type": "Link",
               "rel": "lastKnownEngineHours",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432/engineHours?lastKnown=true"
            },
            {
               "@type": "Link",
               "rel": "alerts",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432/alerts"
            },
            {
               "@type": "Link",
               "rel": "measurements",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432/machineMeasurements"
            },
            {
               "@type": "Link",
               "rel": "hoursOfOperation",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432/hoursOfOperation"
            },
            {
               "@type": "Link",
               "rel": "distanceTraveled",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432/distanceTraveled"
            },
            {
               "@type": "Link",
               "rel": "deviceStateReports",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432/deviceStateReports"
            },
            {
               "@type": "Link",
               "rel": "engineHours",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432/engineHours"
            },
            {
               "@type": "Link",
               "rel": "locationHistory",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/8187/locationHistory"
            },
            {
               "@type": "Link",
               "rel": "workAssignments",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432/workAssignments"
            },
            {
               "@type": "Link",
               "rel": "offsets",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432/offsets"
            },
            {
               "@type": "Link",
               "rel": "capabilities",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432/capabilities"
            }
         ]
      }
   ]
}
 
GET /machines /{machineId}
View A Machine's Info
View details about a specified machine.
 
This endpoint returns detailed information (serial number, VIN, Product Key) about a particular machine or equipment. The response contains links to the following resources:
  • organizations: View the organization to which the machine belongs.
  • locations: View the machine's locations.
  • terminals: View the machine's terminals. This link is currently not followable; this information can also be embedded in the request.
  • displays: View the displays on this machine. This information can also be embedded in the request.
  • measurements: View machine measurements.
  • engineHours: View the machine's engine hours.
  • hoursOfOperation: View the machine's hours of operation.
  • distanceTraveled: View the machine's distance traveled.
  • deviceStateReports: View the machine's device state reports.
  • locationHistory: View the machine's location history.
  • capabilities: Lists machine hardware and software licenses. This information can also be embedded in the request.
  • categories: View machine categories. This information can also be embedded in the request.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/machines/{machineID}
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
Parameter Type Example Description Default Required?
embed string terminals Takes these values: terminals, categories, capabilities, displays.
Separate multiple embeds with commas.
N/A No
 
Response Details
Field Type Example Description
id string 6543 Machine ID
vin string H19791X744421 Machine VIN
name string H09600X635330 Machine name.
productKey string 8241426 Machine product key.
engine SerialNumber string RG7181L103536 Machine's engine's serial number.
telematicsState string active The state of the machine's telematics.
 
Sample Response in JSON
200 OK
Content-Type: application/vnd.deere.axiom.v3+json;charset=UTF-8

{
   "vin": "H19791X744421",
   "name": "H09600X635330",
   "productKey": "8241426",
   "engineSerialNumber": "RG7181L103536",
   "telematicsState": "active",
   "capabilities": [],
   "terminals": {
      "links": null,
      "otherAttributes": {}
   },
   "displays": {
      "links": null,
      "otherAttributes": {}
   },
   "GUID": "cf506f65-f07b-4240-a738-7ca93cac0f62",
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/6543"
      },
      {
         "rel": "organizations",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
      },
      {
         "rel": "locations",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/6543/location"
      },
      {
         "rel": "terminals",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/6543/terminals"
      },
      {
         "rel": "displays",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/6543/displays"
      },
      {
         "rel": "measurements",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/6543/machineMeasurements"
      },
      {
         "rel": "engineHours",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/6543/engineHours"
      },
      {
         "rel": "hoursOfOperation",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/6543/hoursOfOperation"
      },
      {
         "rel": "distanceTraveled",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/6543/distanceTraveled"
      },
      {
         "rel": "deviceStateReports",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/6543/deviceStateReports"
      },
      {
         "rel": "locationHistory",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/6543/locationHistory"
      },
      {
         "rel": "capabilities",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/6543/capabilities"
      },
      {
         "rel": "categories",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/6543/categories"
      }
   ],
   "id": "6543"
}
 
GET /machines /{machineId} /locations
List Machine Locations
The machine location service allows the client to view breadcrumbs of a machine. This data includes the machine's longitude, latitude, and altitude.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/machines/{machineID}/locations
Accept: application/geojson
Accept-Language: locale
 
Request Parameters
Parameter Type Example Description Default Required?
startTime string 2016-03-25T18:42:07.186Z Retrieves results that occurred after a specified date. The format is in the ISO 8601 Standard. N/A No
endTime string 2016-05-25T20:48:07.206Z Retrieves results that occurred before a specified date. The format is in the ISO 8601 Standard. N/A No
 
Response Details
Field Type Example Description
point --- See sample response below. Contains the <lon>, <lat>, and <alt> tags.
lat double 41.688612 Machine location latitude.
lon double -93.693612 Machine location longitude.
eventTimeStamp dateTime 2012-11-07T18:42:07.186Z Timestamp of the machine location report. All timestamps follow the ISO 8601 standard format.
dateTime double 2010-10-04T15:06:24.000Z Timestamp of the machine location first time reports.
 
Sample Response in JSON
200 OK
Content-Type: application/vnd.deere.axiom.v3+json;charset=UTF-8

{
   "type": "FeatureCollection",
   "features": [
      {
         "type": "Feature",
         "geometry": {
            "type": "Point",
            "coordinates": [
               -90.54383,
               41.597164
            ]
         },
         "properties": {
            "eventTimestamp": "2010-10-21T03:32:16.000Z",
            "createTimestamp": "2010-10-21T03:32:16.000Z"
         }
      }
   ]
}
 
POST /machines /{machineId} /ping
Post Machine Ping
The machine ping service allows the client to send the signals to machines and once the machine receives the signal, the telematics gateway will push the recorded data back to JohnDeere cloud.
Note: Only active machines can be pinged.
 
Request URI
POST https://apicert.soa-proxy.deere.com/platform/machines/{machineID}/ping
Accept: application/vnd.deere.axiom.v3+json
 
Request Details
Field Type Example Description
machineId long 6543 Machine ID
 
Sample Response in JSON
204 NO CONTENT
 
GET /machines
List All Machines
This resource allows the client to view a list of a user's telematically enabled machines. If the user is a dealer, they will be able to view their own machines and their customers' machines. If the user is not a dealer, they will be able to view all the machines within all their MyJohnDeere organizations.
 
For each machine listed, the response contains links to the following resources:
  • organizations: View the organization to which the machine belongs.
  • locations: View the machine's locations.
  • terminals: View the machine's terminals. This link is currently unfollowable; this information can also be embedded in the request.
  • displays: View the displays on this machine. This information can also be embedded in the request.
  • measurements: View machine measurements.
  • engineHours: View the machine's engine hours.
  • hoursOfOperation: View the machine's hours of operation.
  • distanceTraveled: View the machine's distance traveled.
  • deviceStateReports: View the machine's device state reports.
  • locationHistory: View the machine's location history.
  • capabilities: Lists machine hardware and software licenses. This information can also be embedded in the request.
  • categories: View machine categories. This information can also be embedded in the request.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/machines
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
Parameter Type Example Description Default Required?
capability string wdt Filters responses by the specified machine capability. N/A No
embed string terminals Takes these values: terminals, categories, capabilities, displays.
Separate multiple embeds with commas.
N/A No
 
Response Details
Field Type Example Description
id string 123456 Machine ID.
vin string 1L06215RJDR782108 The VIN of the machine.
name string 1L06215RJDR782108 The name of the machine.
productKey string 75645342 Machine product key.
engineSerialNumber string CD6068U000150 Machine's engine serial number.
telematicsState string active Indicates whether the machine is telematically active.
 
Sample Response in JSON
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"
      },
      {
         "rel": "nextPage",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines;start=10;count=10"
      }
   ],
   "total": 2,
   "values": [
      {
         "vin": "1L06215RJDR782108",
         "name": "1L06215RJDR782108",
         "productKey": "75645342",
         "engineSerialNumber": "CD6068U000150",
         "telematicsState": "active",
         "capabilities": [],
         "terminals": {
            "links": null,
            "otherAttributes": {}
         },
         "displays": {
            "links": null,
            "otherAttributes": {}
         },
         "GUID": "cf506f65-f07b-4240-a738-7ca93cac0f62",
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/123456"
            },
            {
               "rel": "organizations",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            },
            {
               "rel": "locations",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/123456/location"
            },
            {
               "rel": "terminals",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/123456/terminals"
            },
            {
               "rel": "displays",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/123456/displays"
            },
            {
               "rel": "measurements",
               "uri": "https://apicert.soa-proxy.deere.com/platform/123456/machineMeasurements"
            },
            {
               "rel": "engineHours",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/123456/engineHours"
            },
            {
               "rel": "hoursOfOperation",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/123456/hoursOfOperation"
            },
            {
               "rel": "distanceTraveled",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/123456/distanceTraveled"
            },
            {
               "rel": "deviceStateReports",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/123456/deviceStateReports"
            },
            {
               "rel": "locationHistory",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/123456/locationHistory"
            },
            {
               "rel": "capabilities",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/123456/capabilities"
            },
            {
               "rel": "categories",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/123456/categories"
            }
         ],
         "id": "123456"
      },
      {
         "vin": "1L93847RJDR028395",
         "name": "1L93847RJDR028395",
         "productKey": "83474756",
         "engineSerialNumber": "AB9384R703821",
         "telematicsState": "active",
         "capabilities": [],
         "terminals": {
            "links": null,
            "otherAttributes": {}
         },
         "displays": {
            "links": null,
            "otherAttributes": {}
         },
         "GUID": "cf506f65-f07b-4240-a738-7ca93cac0f62",
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/83746"
            },
            {
               "rel": "organizations",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            },
            {
               "rel": "locations",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/83746/location"
            },
            {
               "rel": "terminals",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/83746/terminals"
            },
            {
               "rel": "displays",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/83746/displays"
            },
            {
               "rel": "measurements",
               "uri": "https://apicert.soa-proxy.deere.com/platform/83746/machineMeasurements"
            },
            {
               "rel": "engineHours",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/83746/engineHours"
            },
            {
               "rel": "hoursOfOperation",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/83746/hoursOfOperation"
            },
            {
               "rel": "distanceTraveled",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/83746/distanceTraveled"
            },
            {
               "rel": "deviceStateReports",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/83746/deviceStateReports"
            },
            {
               "rel": "locationHistory",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/83746/locationHistory"
            },
            {
               "rel": "capabilities",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/83746/capabilities"
            },
            {
               "rel": "categories",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/83746/categories"
            }
         ],
         "id": "83746"
      }
   ]
}