GET
/files
List Files
GET
/files/{fileID}
View/Download A File
POST
/organizations/{orgId}/files
Create A File ID
PUT
/files/{fileID}
Upload/Update A File
GET
/organizations/{orgId}/files
List an Org's Files
Growers use many different types of files to help them with their operations, including Prescription, Setup, documentation, and more. MyJohnDeere API can enable your client to access their files on Operations Center and share these files with their trusted advisors, such as agronomists.
GET /files
List Files
This resource retrieves the list of files available and lets you view the doc files from recent field operations. For each file, the response will link to the following resources:
  • owningOrganization: View the org that owns the file.
  • partnerships: View the partners this file is shared with.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/files
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
Parameter Type Example Description Default Required?
filter string MACHINE Takes ALL or MACHINE. ALL shows all the files in the org. MACHINE shows only the files sent from a machine to the host. ALL No
fileType integer 0 Takes the file type number.1 N/A No
 
Response Details
Field Type Example Description
id string 577499742 The name of the file.
name string back40.zip The name of the file.
type string SETUP The type of the file.1
createdTime dateTime 2015-02-03T10:42:24.282Z Time at which the file was created.2
modifiedTime dateTime 2015-02-03T10:42:24.282Z Time at which the file was last modified.2
nativeSize integer 72946 Size of the file.
source string JohnDoe Account with which the file was created.
transfer Pending boolean false Indicates whether the file is currently in a pending transfer to a machine.
visible ViaShare string owned Indicates whether you own the file, or it was shared with you. The value will be either "owned" or "manual".
shared boolean false Indicates whether the file is shared with another org.
status string UPLOAD_PENDING Indicates whether the file can be transfered to a machine. Possible values are: Upload Pending, Ready, and In Progress.
archived boolean false Indicates whether the file has been archived.
new boolean false Indicates whether the file is new.
format String IntegraVersaPlugin Indicates the plugin type.
manufacturer String AgLeader Indicates the manufacturer.
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/files"
      },
      {
         "rel": "nextPage",
         "uri": "https://apicert.soa-proxy.deere.com/platform/files;start=10;count=10"
      }
   ],
   "total": 1,
   "values": [
      {
         "links": [
            {
               "rel": "owningOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            },
            {
               "rel": "partnerships",
               "uri": "https://apicert.soa-proxy.deere.com/platform/files/466578633/partnerships"
            },
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/files/466578633"
            }          ],          "id": "577499742",
         "name": "back40.zip",
         "type": "SETUP",
         "createdTime": "2015-02-03T10:42:24.282Z",
         "modifiedTime": "2015-02-03T10:42:24.282Z",
         "nativeSize": "72946",
         "source": "JohnDoe",
         "transferPending": "false",
         "visibleViaShare": "owned",
         "shared": "false",
         "status": "UPLOAD_PENDING",
         "archived": "false",
         "new": "true",
         "format": "IntegraVersaPlugin",
         "manufacturer": "AgLeader"
      }
   ]
}
 
[1] File Types:
Number Type Description
0 SETUP Collection of attributes sent to a precision agricultural display to help ensure accurate execution and documentation of work. Examples of the attributes include: client, farm, field, boundary, guidance lines, products, machines, implements, operators, and equipment offsets.
1 PRESCRIPTION A file developed for a precision agricultural display and implement controller to command the rate of product applied for a specific zone inside a predefined boundary.
2 INVALID The uploaded file has an unsupported format. The file cannot be processed, downloaded, or sent to a machine.
3 UNKNOWN This file has not yet been fully uploaded or is still being processed. Once processed, the type should be automatically updated.
4 DOC Operational data captured from a precision agricultural display. The approved data operations are: Seeding, Harvest, Application, Tillage & Other.
6 HIC Eleven geospatially traceable attributes documenting the quality of each cotton module harvested by a John Deere 7760 Cotton Picker with the added Application Controller.
7 TIMBERLINK N/A
8 EXPORT Removal of processed and edited field data from Operations Center in a shapefile format.
11 TIMBERMATIC N/A
13 PDF A normal PDF file.
 
[2] All timestamps are in the ISO 8601 format.
 
GET /files /{filesID}
View/Download A File
This resource allows the client to view or download a file.
Note: Only files smaller than 50 MB can be downloaded at once. Larger files will need to be downloaded in chunks. To download in chunks, you can use the Range request header, or the offset and size request parameters. If both are used, the request header will take precedence.
 
To view a file's metadata, choose the application/vnd.deere.axiom.v3+xml or application/vnd.deere.axiom.v3+json Accept Headers. To download the file to the client software, choose a /zip or octet-stream Accept Header. The following example will show a GET call to view a file's metadata. The response will contain links to the following resources:
  • owningOrganization: View the org that owns the file.
  • partnerships: View a list of the partnerships through which the file is shared, if applicable.
  • initiateFileTransfer: Request to send this file to a specified machine.
  • wdtCapableMachines: View a list of machines in the org which can receive this file.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/files/{fileID}
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
  • application/zip
  • application/octet-stream
  • application/x-zip
  • application/x-zip-compressed
  • multipart/mixed
  • application/vnd.deere.axiom.v3+xml
  • application/vnd.deere.axiom.v3+json
 
Request Headers
To download the file in chunks of bytes, you can use the range header with the following form: Range:bytes=startIndex-endIndex
Sample Header: Range:bytes=0-1000
 
Request Parameters
Parameter Type Example Description Default Required?
offset integer -1 Allows client to download file in chunks. -1 will download entire file. For smaller pieces, enter offset point (in bytes) in this parameter. N/A Yes
size integer -1 Allows client to download file in chunks. -1 will download entire file. For smaller pieces, enter size (in bytes) in this parameter. N/A Yes
 
Response Details
Field Type Example Description
id string 577499742 The name of the file.
name string back40.zip The name of the file.
type string SETUP The type of the file.1
createdTime dateTime 2015-02-03T10:42:24.282Z Time at which the file was created.2
modifiedTime dateTime 2015-02-03T10:42:24.282Z Time at which the file was last modified.2
nativeSize integer 72946 Size of the file.
source string JohnDoe Account with which the file was created.
transfer Pending boolean false Indicates whether the file is currently in a pending transfer to a machine.
visible ViaShare string owned Indicates whether you own the file, or it was shared with you. The value will be either "owned" or "manual".
shared boolean false Indicates whether the file is shared with another org.
status string UPLOAD_PENDING Indicates whether the file can be transfered to a machine. Possible values are: Upload Pending, Ready, and In Progress.
archived boolean false Indicates whether the file has been archived.
new boolean false Indicates whether the file is new.
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "owningOrganization",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/2101"
      },
      {
         "rel": "partnerships",
         "uri": "https://apicert.soa-proxy.deere.com/platform/files/466578633/partnerships"
      },
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/files/466578633"
      }
   ],
   "id": "577499742",
   "name": "back40.zip",
   "type": "SETUP",
   "createdTime": "2015-02-03T10:42:24.282Z",
   "modifiedTime": "2015-02-03T10:42:24.282Z",
   "nativeSize": "72946",
   "source": "JohnDoe",
   "transferPending": "false",
   "visibleViaShare": "owned",
   "shared": "false",
   "status": "UPLOAD_PENDING",
   "archived": "false",
   "new": "true"
}
 
[1] File Types:
Number Type Description
0 SETUP Collection of attributes sent to a precision agricultural display to help ensure accurate execution and documentation of work. Examples of the attributes include: client, farm, field, boundary, guidance lines, products, machines, implements, operators, and equipment offsets.
1 PRESCRIPTION A file developed for a precision agricultural display and implement controller to command the rate of product applied for a specific zone inside a predefined boundary.
2 INVALID The uploaded file has an unsupported format. The file cannot be processed, downloaded, or sent to a machine.
3 UNKNOWN This file has not yet been fully uploaded or is still being processed. Once processed, the type should be automatically updated.
4 DOC Operational data captured from a precision agricultural display. The approved data operations are: Seeding, Harvest, Application, Tillage & Other.
6 HIC Eleven geospatially traceable attributes documenting the quality of each cotton module harvested by a John Deere 7760 Cotton Picker with the added Application Controller.
7 TIMBERLINK N/A
8 EXPORT Removal of processed and edited field data from Operations Center in a shapefile format.
11 TIMBERMATIC N/A
13 PDF A normal PDF file.
 
[2] All timestamps are in the ISO 8601 format.
 
POST /organizations {orgId} /files
Create A File ID
Create a file ID. The client must do this before uploading a file.
 
 
The POST call below shows the creation of file id "55" in organization "73" in MyJohnDeere. The client software can connect to MyJohnDeere API v3 to create the file name URI, and  upload the file.
 
Request URI
POST https://apicert.soa-proxy.deere.com/platform/organizations/{orgId}/files
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
Content Type: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Sample Request Body in JSON
{
"name": "back40Seeding.zip"
}
 
PUT /files /{filesID}
Upload/Update A File
This resource allows the client to upload or update a file.  The client must create a file ID before uploading a file.
 
 
To upload or update a file, make a PUT call instead of GET. Before uploading a file, remember to create the file ID. The following example will show a GET call to view a file's metadata.
 
Request URI
PUT https://apicert.soa-proxy.deere.com/platform/files/{fileID}
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Note: In your sample request for uploading a file, the content-type can be any of the following:
  • application/octet-stream
  • application/zip
  • application/x-zip
  • application/x-zip-compressed
  • multipart/form-data
  • multipart/mixed
 
Sample Request Body: Upload a File
PUT https://api.soa-proxt.deere.com/platform/files/5172646

Accept: application/vnd.deere.axiom.v3+json
Authorization: OAuth realm="",oauth_timestamp="1406138640", oauth_nonce="I2sX0Z", oauth_consumer_key="com.deere.impersonation"
, oauth_token="a5633e06-bd09-43a5-942a-2e1255681ca9", oauth_version="1.0", oauth_signature_method="HMAC-SHA1", oauth_signature="CX7E9KJra9ok5WpIejjFpafh8lE%3D"
Content-Type: application/octet-stream
Sample Response
200 OK

Pragma: no-cache
Date: Wed, 23 Jul 2014 18:04:00 GMT
Server: Apache-Coyote/1.1
X-Deere-Handling-Server: ldxtc1
X-Deere-Elapsed-Ms: 645
Transfer-Encoding: chunked
Content-Language: en-US
Content-Type: application/vnd.deere.axiom.v3+json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0
Connection: Keep-Alive
Keep-Alive: timeout=5, max=100
Expires: Thu, 01 Jan 1970 00:00:00 GMT
 
The example below shows how to update a file. In this example, we archive a file.
 
Sample Request Body: Update a File
PUT https://api.soa-proxt.deere.com/platform/files/5172646

Accept: application/vnd.deere.axiom.v3+json
Authorization: OAuth realm="", oauth_timestamp="1406138640", oauth_nonce="I2sX0Z", oauth_consumer_key="com.deere.impersonation"
, oauth_token="a5633e06-bd09-43a5-942a-2e1255681ca9", oauth_version="1.0", oauth_signature_method="HMAC-SHA1", oauth_signature="CX7E9KJra9ok5WpIejjFpafh8lE%3D"
Content-Type: application/vnd.deere.axiom.v3+json

{
  "id":"5172646",
  "archived":true
}
Sample Response
200 OK

Pragma: no-cache
Date: Wed, 23 Jul 2014 18:04:00 GMT
Server: Apache-Coyote/1.1
X-Deere-Handling-Server: ldxtc1
X-Deere-Elapsed-Ms: 645
Transfer-Encoding: chunked
Content-Language: en-US
Content-Type: application/vnd.deere.axiom.v3+json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0
Connection: Keep-Alive
Keep-Alive: timeout=5, max=100
Expires: Thu, 01 Jan 1970 00:00:00 GMT
 
GET /organizations {orgId} /files
List an Org's Files
View a list of an org's files. This resource allows for pagination. For each returned file, the response will link to the following resources:
  • owningOrganization: View the org that owns the file.
  • partnerships: View the partnerships through which the file is shared, if applicable.
  • initiateFileTransfer: Submit a transfer request for the specified file.
  • machinesEligibleToReceiveFile: List of WDT-capable machines that the specified file can be sent to.
  • sendFileToMachine: The same as "initiateFileTransfer."
  • wdtCapableMachines: The same as "machinesEligibleToReceiveFile."
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/organizations/{orgID}/files
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
Parameter Type Example Description Default Required?
filter string MACHINE Takes ALL or MACHINE.  ALL shows all the files in the org. MACHINE shows only the files sent from a machine to the host. ALL No
start Date date Time 2013-01- 04T14:08: 51.104Z Takes a timestamp (in UTC) that indicates when the file was created. Timestamp format is the  ISO 8601 standard. N/A No
end Date date Time 2015-02- 03T10:42: 24.282Z Takes a timestamp (in UTC) that indicates when the file was created. Timestamp format is the ISO 8601 standard. N/A No
fileType integer 1 Takes a number that identifies the file type.1 N/A No
archived boolean TRUE Allows client to filter files according to whether they have been archived. TRUE returns only archived files. FALSE No
status string TRANS FERABLE Allows client to filter files according to whether they are transferable to machines. Takes TRANSFERABLE and NON_TRANSFERABLE. N/A No
 
Response Details
Field Type Example Description
id string 577499742 The name of the file.
name string back40.zip The name of the file.
type string SETUP The type of the file.1
created Time dateTime 2013-01- 04T14:08: 51.104Z Time at which the file was created.2
modifiedTime dateTime 2013-01- 04T14:08: 51.104Z Time at which the file was last modified.2
nativeSize integer 72946 Size of the file.
source string JohnDoe Account with which the file was created.
transfer Pending boolean false Indicates whether the file is currently in a pending transfer to a machine.
visible ViaShare string owned Indicates whether you own the file, or it was shared with you. The value will be either "owned" or "manual".
shared boolean false Indicates whether the file is shared with another org.
status string UPLOAD_ PENDING Indicates whether the file can be transfered to a machine. Possible values are: Upload Pending, Ready, and In Progress.
archived boolean false Indicates whether the file has been archived.
new boolean false Indicates whether the file is new.
 
Sample Request Body in JSON
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/files"
      },
      {
         "rel": "nextPage",
         "uri": "https://apicert.soa-proxy.deere.com/platform/files;start=10;count=10"
      }
   ],
   "total": 1534,
   "values": [
      {
         "links": [
            {
               "rel": "owningOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            },
            {
               "rel": "partnerships",
               "uri": "https://apicert.soa-proxy.deere.com/platform/files/466578633/partnerships"
            },
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/files/466578633"
            }
         ],
         "id": "577499742",
         "name": "back40.zip",
         "type": "SETUP",
         "createdTime": "2013-01-04T14:08:51.104Z",
         "modifiedTime": "2013-01-04T14:08:51.104Z",
         "nativeSize": "72946",
         "source": "JohnDoe",
         "transferPending": "false",
         "visibleViaShare": "owned",
         "shared": "false",
         "status": "UPLOAD_PENDING",
         "archived": "false",
         "new": "true"
      }
   ]
}
 
[1] File Types:
Number Type Description
0 SETUP Collection of attributes sent to a precision agricultural display to help ensure accurate execution and documentation of work. Examples of the attributes include: client, farm, field, boundary, guidance lines, products, machines, implements, operators, and equipment offsets.
1 PRESCRIPTION A file developed for a precision agricultural display and implement controller to command the rate of product applied for a specific zone inside a predefined boundary.
2 INVALID The uploaded file has an unsupported format. The file cannot be processed, downloaded, or sent to a machine.
3 UNKNOWN This file has not yet been fully uploaded or is still being processed. Once processed, the type should be automatically updated.
4 DOC Operational data captured from a precision agricultural display. The approved data operations are: Seeding, Harvest, Application, Tillage & Other.
6 HIC Eleven geospatially traceable attributes documenting the quality of each cotton module harvested by a John Deere 7760 Cotton Picker with the added Application Controller.
7 TIMBERLINK N/A
8 EXPORT Removal of processed and edited field data from Operations Center in a shapefile format.
11 TIMBERMATIC N/A
13 PDF A normal PDF file.
 
[2] All timestamps are in the ISO 8601 format.