GET
/organizations/{orgId}/managementZones/{zoneId}/notes
List Notes
GET
/organizations/{orgId}/notes
List Notes by Organization
GET /organizations/{orgId} /managementZones/{zoneId} /notes
List Notes
This resource will return notes within the specified date range for the given Management Zone.
 
Request URI
GET https://sandboxapi.deere.com/fc/organizations/{orgId}/managementZones/{zoneId}/notes
Accept: application/vnd.deere.axiom.v3+json
 
Parameters
Parameter Type Example Description Default In Required?
orgId string 1234 Organization ID N/A path Yes
managementZoneId string 1026e6d3-4k23-58eg-73ec-j3885h4b8lk3 Management Zone ID N/A path Yes
embed string pertainingTo Returns related management zone and probe serial numbers that pertain to the note.
N/A query No
uom string EN Choose English or Metric unit of measurement. ME query No
startDate dateTime 2015-06-18T05:00:00.000Z Timestamp of the starting point for the time range. N/A query Yes
endDate dateTime 2015-06-22T05:00:00.000Z Timestamp of the ending point for the time range. N/A query Yes
 
Response Details
Field Type Example Description
text string Hello Note text.
placedOnDate datetime 2015-05-19T15:08:39.423Z Date the note was placed.
noteType string GENERAL Note type
dateModified datetime 2015-05-19T15:08:39.423Z Date the note was last modified.
dateCreated datetime 2015-05-19T15:08:39.422Z Date the note was created.
creator string Ned Land Creator of the note.
 
Sample Response [JSON]
200 OK

{
   "links": [
      {
         "rel": "self",
         "uri": "https://sandboxapi.deere.com/fc/organizations/1234/managementZones/1026e6d3-4k23-58eg-73ec-j3885h4b8lk3/notes?embed=pertainingTo"
      }
   ],
   "total": 2,
   "values": [
      {
         "text": "Hello",
         "placedOnDate": "2015-07-09T23:05:00.000Z",
         "noteType": "GENERAL",
         "pertainingTo": {
            "managementZone": {
               "name": "After Data Refresh12 Management Zone",
               "fieldName": "After RTE Refresh-Land1",
               "soilType": "Clay Loam",
               "waterManagementMethod": "Flood or furrow",
               "cropEmergenceDate": "2015-05-09T05:00:00.000Z",
               "estimatedMaturityDate": "2015-11-01T04:59:00.000Z",
               "cropType": "Cotton",
               "id": "c863efe0-5c32-4df4-abfb-c11700d7c428"
            }
         },
         "dateModified": "2015-07-10T12:50:08.679Z",
         "dateCreated": "2015-07-10T12:46:57.825Z",
         "creator": "Ned Land"
      },
      {
         "text": "It's sunny!",
         "placedOnDate": "2015-07-14T15:56:00.000Z",
         "noteType": "SUNNY",
         "pertainingTo": {
            "probe": {
               "serialNumber": "PCPB02A300085"
            }
         },
         "dateModified": "2015-07-14T15:57:01.668Z",
         "dateCreated": "2015-07-14T15:57:01.668Z",
         "creator": "Captain Nemo"
      }
   ]
}
 
GET /organizations /{orgId} /notes
List Notes by Organization
This resource will return notes within the specified date range within a specific Organization.
 
Request URI
GET https://sandboxapi.deere.com/fc/organizations/{orgId}/notes
Accept: application/vnd.deere.axiom.v3+json
 
Parameters
Parameter Type Example Description Default In Required?
orgId string 1234 Organization ID N/A path Yes
filter string all Returns all notes, including archived notes. Default does not return archived notes. query No
embed string pertainingTo Returns related management zone and probe serial numbers that pertain to the note.
N/A query No
uom string EN Choose English or Metric unit of measurement. ME query No
startDate dateTime 2015-06-18T05:00:00.000Z Timestamp of the starting point for the time range. N/A query Yes
endDate dateTime 2015-06-22T05:00:00.000Z Timestamp of the ending point for the time range. N/A query Yes
Note: If a date range is not given in the request, the last seven days of notes for an Organization will be returned.
 
Response Details
Field Type Example Description
text string Hello Note text.
placedOnDate datetime 2015-05-19T15:08:39.423Z Date the note was placed.
noteType string GENERAL Note type
dateModified datetime 2015-05-19T15:08:39.423Z Date the note was last modified.
dateCreated datetime 2015-05-19T15:08:39.422Z Date the note was created.
creator string Ned Land Creator of the note.
 
Sample Response [JSON]
200 OK

{
   "links": [
      {
         "rel": "self",
         "uri": "https://sandboxapi.deere.com/fc/organizations/1234/notes"
      }
   ],
   "total": 2,
   "values": [
      {
         "text": "Sunshine today",
         "placedOnDate": "2015-08-04T05:00:00.000Z",
         "noteType": "SUNNY",
         "dateModified": "2015-08-10T15:08:16.394Z",
         "dateCreated": "2015-08-10T15:08:16.394Z",
         "creator": "Ned Land"
      },
      {
         "text": "It might rain",
         "placedOnDate": "2015-08-05T05:00:00.000Z",
         "noteType": "CLOUDY",
         "dateModified": "2015-08-10T15:09:02.943Z",
         "dateCreated": "2015-08-10T15:09:02.943Z",
         "creator": "E. A. Poe"
      }
   ]
}