POST
/organizations/{orgId}/fileTransfers
Submit a File Transfer Request
GET
/fileTransfers
List File Transfer Requests
GET
/fileTransfers/{id}
View a File Transfer Request
With MyJohnDeere API, applications can allow users to transfer files automatically from Operations Center to their telematically enabled machines. Previously, Operations Center users had to transfer files to machines manually, via a flash drive.
POST /organizations /{orgId} /fileTransfers
Submit a File Transfer Request
This resource allows you to select a file and machine, and use the client software to submit a file transfer request. After that, MyJohnDeere API v3's infrastructure transfers the selected file to the selected machine, where it becomes available for the machine operator to use. The response links to the following resources:
  • file: View the file for which the transfer was requested.
  • machine: View the machine to which the transfer was requested.
 
Request URI
POST https://apicert.soa-proxy.deere.com/platform/organizations/{orgId}/fileTransfers
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Sample Request: Upload a File [JSON]
Content-Type: application/vnd.deere.axiom.v3+xml or application/vnd.deere.axiom.v3+json
Content-Length: 328

{
   "links": [
      {
         "rel": "file",
         "uri": "https://apicert.soa-proxy.deere.com/platform/files/4862148"
      },
      {
         "rel": "machine",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/124399"
      }
   ]
}

201 Created
Location:https://apicert.soa-proxy.deere.com/platform/filesTransfers/7482
 
GET /fileTransfers
List File Transfer Requests
This resource allows the client to check the status of a file transfer request that has already been submitted.
 
The response will contain links to the following resources:
  • file: View the file for which the transfer was requested.
  • machine: View the machine to which the transfer was requested.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/fileTransfers/{id}
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
Parameter Type Example Description Default Required?
Source string ORGANIZATION The source of the file transfer. Takes the values ORGANIZATION or MACHINE. N/A No
 
Response Details
Field Type Example Description
file --- See sample response below. Information on the transfered file, including name, type, created type, modified time, native size, source, status, and whether it was archived.
id string 51234 File Transfer ID
source string HOST File source. If the request parameter value for source is MACHINE, this response value will also be MACHINE. If the request parameter value for source is ORGANIZATION, this response value will be HOST.
transferInitiation Time dateTime 2013-01- 04T14:08:51.104Z Timestamp of when the file transfer was initiated. All timestamps are formatted according to the ISO 8601 standard.
lastUpdatedTime dateTime 2013-01- 04T14:08:51.130Z Timestamp of when the file transfer was last updated. All timestamps are formatted according to the ISO 8601 standard.
status string WDT_IN_PROCESS Status of the file transfer.1
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/fileTransfers"
      },
      {
         "rel": "nextPage",
         "uri": "https://apicert.soa-proxy.deere.com/platform/fileTransfers;start=10;count=10"
      }
   ],
   "total": 2,
   "values": [
      {
         "file": {
            "name": "transferedFile1.zip",
            "type": "SETUP",
            "createdTime": "2014-01-13T12:15:51.159Z",
            "modifiedTime": "2014-01-13T12:16:09.443Z",
            "nativeSize": 927025,
            "source": "FitzwilliamDarcy",
            "status": "READY",
            "archived": false,
            "links": [
               {
                  "rel": "self",
                  "uri": "https://apicert.soa-proxy.deere.com/platform/files/7456"
               }
            ],
            "id": "51234"
         },
         "source": "HOST",
         "transferInitiationTime": "2014-01-13T12:16:15.924Z",
         "lastUpdatedTime": "2014-01-13T12:16:15.924Z",
         "status": "WDT_IN_PROCESS",
         "links": [
            {
               "rel": "file",
               "uri": "https://apicert.soa-proxy.deere.com/platform/files/612"
            },
            {
               "rel": "machine",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/1523"
            },
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/fileTransfers/6234"
            }
         ],
         "id": "4799048"
      },
      {
         "file": {
            "name": "transferedFile2.zip",
            "type": "SETUP",
            "createdTime": "2015-01-17T15:15:55.732Z",
            "modifiedTime": "2015-01-17T15:15:56.242Z",
            "nativeSize": 6813,
            "source": "LydiaBennett",
            "status": "READY",
            "archived": false,
            "links": [
               {
                  "rel": "self",
                  "uri": "https://apicert.soa-proxy.deere.com/platform/files/12345"
               }
            ],
            "id": "1219063"
         },
         "source": "HOST",
         "transferInitiationTime": "2013-01-17T15:18:41.512Z",
         "lastUpdatedTime": "2013-05-02T20:06:43.732Z",
         "status": "WDT_OPERATOR_REJECTED",
         "links": [
            {
               "rel": "file",
               "uri": "https://apicert.soa-proxy.deere.com/platform/files/615"
            },
            {
               "rel": "machine",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/243"
            },
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/fileTransfers/7354"
            }
         ],
         "id": "1219096"
      }
   ]
}
 
[1] File Transfer Statuses
Value Definition
WDT_IN_PROGRESS The file transfer request is on its way to the machine's display.
WDT_SUCCESS The file transfer request has been successfully transferred.
WDT_FAILED The file transfer has failed.
WDT_AVAILABLE_TO_DISPLAY The file is on the 2630.
WDT_OPERATOR_ACCEPTED The file has been accepted by the operator on the machine.
WDT_OPERATOR_REJECTED The file has been rejected by the operator on the machine.
WDT_INVALID_FILE The display cannot read the file.
WDT_ERROR An internal error has occurred.
WDT_QUEUED The file is now ready to go to the machine display.
 
GET /fileTransfers /{id}
View a File Transfer Request
This resource allows the client to check the status of a file transfer request that has already been submitted.
 
The response will contain links to the following resources:
  • file: View the file for which the transfer was requested.
  • machine: View the machine to which the transfer was requested.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/fileTransfers/{id}
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
Parameter Type Example Description Default Required?
Source string ORGANIZATION The source of the file transfer. Takes the values ORGANIZATION or MACHINE. N/A No
 
Response Details
Field Type Example Description
file --- See sample response below. Information on the transfered file, including name, type, created type, modified time, native size, source, status, and whether it was archived.
id string 1628996 File Transfer ID
source string HOST File source. If the request parameter value for source is MACHINE, this response value will also be MACHINE. If the request parameter value for source is ORGANIZATION, this response value will be HOST.
transferInitiation Time dateTime 2013-01- 04T14:08:51.104Z Timestamp of when the file transfer was initiated. All timestamps are formatted according to the ISO 8601 standard.
lastUpdatedTime dateTime 2013-01- 04T14:08:51.130Z Timestamp of when the file transfer was last updated. All timestamps are formatted according to the ISO 8601 standard.
status string WDT_IN_PROCESS Status of the file transfer.1
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "file": {
      "name": "transferedFile1.zip",
      "type": "SETUP",
      "createdTime": "2015-06-09T09:42:55.817Z",
      "modifiedTime": "2015-06-09T09:43:01.693Z",
      "nativeSize": 9440,
      "source": "FitzwilliamDarcy",
      "status": "READY",
      "archived": false,
      "links": [
         {
            "rel": "self",
            "uri": "https://apicert.soa-proxy.deere.com/platform/files/15234"
         }
      ],
      "id": "15234"
   },
   "source": "HOST",
   "transferInitiationTime": "2015-06-09T09:43:01.381Z",
   "lastUpdatedTime": "2015-06-09T09:43:01.384Z",
   "status": "WDT_IN_PROCESS",
   "links": [
      {
         "rel": "file",
         "uri": "https://apicert.soa-proxy.deere.com/platform/files/15234"
      },
      {
         "rel": "machine",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/8237"
      },
      {
         "rel": "owningOrganization",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
      },
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/fileTransfers/61243"
      }
   ],
   "id": "571637605"
}
 
[1] File Transfer Statuses
Value Definition
WDT_IN_PROGRESS The file transfer request is on its way to the machine's display.
WDT_SUCCESS The file transfer request has been successfully transferred.
WDT_FAILED The file transfer has failed.
WDT_AVAILABLE_TO_DISPLAY The file is on the 2630.
WDT_OPERATOR_ACCEPTED The file has been accepted by the operator on the machine.
WDT_OPERATOR_REJECTED The file has been rejected by the operator on the machine.
WDT_INVALID_FILE The display cannot read the file.
WDT_ERROR An internal error has occurred.
WDT_QUEUED The file is now ready to go to the machine display.