GET
/farms
List Farms
GET
/organizations/{orgID}/farms
List Farms in an Org
GET
/organizations/{orgID}/farms/{id}
View a Farm
GET
/organizations/{orgID}/clients/{id}/farms
View a Client's Farm
GET
/organizations/{orgID}/fields/{id}/farms
View the Farm that Owns a Field
 
Learn more about farms.
Become a beta tester for FieldDetails resources.
A farm is a set of fields associated with a client.
GET /farms
View Farms
View the details of a specific farm. For each farm, the response will link to the following resources:
  • fields: View the fields in this farm.
  • clients: View the client that owns this farm.
  • owningOrganization: View the organization that owns the farm.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/farms
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
This resource does not currently take any filters/request parameters.
 
Response Details
Field Type Example Description
id string MTY4MDY3XzJjYzM3 Farm ID
name string Arronax Farm Farm Name
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/farms"
      }
   ],
   "total": 2,
   "values": [
      {
         "name": "Cair Paravel",
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MTY4MDY3XzJjYzM3"
            },
            {
               "rel": "fields",
               "uri": "https://apicert.soa-proxy.deere.comm/platform/organizations/1234/farms/MTY4MDY3XzJjYzM3/fields"
            },
            {
               "rel": "clients",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MTY4MDY3XzJjYzM3/clients"
            },
            {
               "rel": "owningOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            }
         ],
         "id": "MTY4MDY3XzJjYzM3"
      },
      {
         "name": "Arronax Farm",
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MMTY4MDY3XzQ0MzB"
            },
            {
               "rel": "fields",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MTY4MDY3XzQ0MzB/fields"
            },
            {
               "rel": "clients",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MTY4MDY3XzQ0MzB/clients"
            },
            {
               "rel": "owningOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            }
         ],
         "id": "MTY4MDY3XzQ0MzB"
      }
   ]
}
GET /organizations /{orgID} farms
View Farms in an Org
View a list of farms belonging to an organization. For each farm, the response will link to the following resources:
  • fields: View the fields in this farm.
  • clients: View the client that owns this farm.
  • owningOrganization: View the org that owns this farm.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/organizations/{orgID}/farms
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
This resource does not currently take any filters/request parameters.
 
Response Details
Field Type Example Description
id string MjEwMV81MGJl Client ID
name string Ned's Farm Farm Name
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms"
      }
   ],
   "total": 1,
   "values": [
      {
         "name": "Ned's Farm",
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MjEwMV81MGJl"
            },
            {
               "rel": "fields",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MjEwMV81MGJl/fields"
            },
            {
               "rel": "clients",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MjEwMV81MGJl/clients"
            },
            {
               "rel": "owningOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            }
         ],
         "id": "MjEwMV81MGJl"
      }
   ]
}
GET /organizations/{orgID} /farms /{id}
View a Farm
View the details of a specific farm. The response will link to the following resources:
  • fields: View fields in this farm.
  • clients: View the client that owns this farm.
  • owningOrganization: View the Organization that owns the farm.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/organizations/{orgID}/farms/{id}
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
This resource does not currently take any filters/request parameters.
 
Response Details
Field Type Example Description
id string MTY4MDY3XzQ0MzB Farm ID
name string Aronnax Farm Farm Name
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "name": "Aronnax Farm",
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MTY4MDY3XzQ0MzB"
      },
      {
         "rel": "fields",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MTY4MDY3XzQ0MzB/fields"
      },
      {
         "rel": "clients",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MMTY4MDY3XzQ0MzB/clients"
      },
      {
         "rel": "owningOrganization",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
      }
   ],
   "id": "MTY4MDY3XzQ0MzB"
}
GET /organizations/{orgID} /clients/{id} /farms
View a Client's Farms
View a list of farms belonging to a specified client. For each farm, the response will link to the following resources:
  • fields: View the fields in this farm.
  • clients: View the clients that own this farm.
  • owningOrganization: View the Organization that owns the farm.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/organizations/{orgID}/clients/{id}/farms
Accept: application/vnd.deere.axiom.v3+xml or application/vnd.deere.axiom.v3+json
 
Request Parameters
This resource does not currently take any filters/request parameters.
 
Response Details
Field Type Example Description
id string MjEwMV81MGJl Farm ID
name string Ned's Farm Farm Name
 
Sample Response in JSON
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/clients/MjEwMV81MGJl/farms"
      }
   ],
   "total": 1,
   "values": [
      {
         "name": "Ned's Farm",
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MjEwMV81MGJl"
            },
            {
               "rel": "fields",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MjEwMV81MGJl/fields"
            },
            {
               "rel": "clients",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MjEwMV81MGJl/clients"
            },
            {
               "rel": "owningOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            }
         ],
         "id": "MjEwMV81MGJl"
      }
   ]
}
GET /organizations/{orgID} /fields/{id} /farms
View the Farm that Owns a Field
View details about the farm that owns a specified field. For the field, the response will link to the following resources:
  • fields: View the fields in this farm.
  • clients: View the clients that own this farm.
  • owningOrganization: View the Organization that owns the farm.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/organizations/{orgID}/fields/{id}/farms
Accept: application/vnd.deere.axiom.v3+xml or application/vnd.deere.axiom.v3+json
 
Request Parameters
This resource does not currently take any filters/request parameters.
 
Response Details
Field Type Example Description
id string MjEwMV9mNjIzYjE3ZGU Field ID
name string Aronnax Farm Field Name
 
Sample Response in JSON
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/fields/MWUxZTExODZiMzg/farms"
      }
   ],
   "total": 1,
   "values": [
      {
         "name": "Aronnax Farm",
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MjEwMV9mNjIzYjE3ZGU"
            },
            {
               "rel": "fields",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MjEwMV9mNjIzYjE3ZGU/fields"
            },
            {
               "rel": "clients",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MjEwMV9mNjIzYjE3ZGU/clients"
            },
            {
               "rel": "owningOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            }
         ],
         "id": "MjEwMV9mNjIzYjE3ZGU"
      }
   ]
}