Retrieve all of the Fields for an Organization
GET
Request URI
GET https://sandboxapi.deere.com/platform/organizations/{orgId}/fields
Accept: application/vnd.deere.axiom.v3+json
Parameters
Parameter | Type | Description & Example | In |
---|---|---|---|
clientName | string | client name | query |
farmName | string | farm name | query |
fieldName | string | field name | query |
embed | array | list of objects to include | query |
recordFilter | string | Filters by resource state (whether or not the resource is archived) Allowed Values: AVAILABLE,ARCHIVED,ALL | query |
Accept-UOM-System | string | Indicates a preference for returned measurements to be in English vs Metric Allowed Values: METRIC,ENGLISH | header |
orgId Required | integer | The ID of the organization | path |
Response Details
Field | Type | Description & Example |
---|---|---|
@Type | string | --- Example: Field |
name | string | --- Example: --- |
farms | object | --- |
@Type | string | --- Example: Farms |
farms | Array of object | --- |
@Type | string | --- Example: Farm |
name | string | --- Example: --- |
id | string | --- Example: 1efb4de1-fe41-42bc-bbb3-d128a432cafd |
links | Array of object | --- |
rel | string | --- Example: self |
uri | string | --- Example: https://apiqa.tal.deere.com/platform/users/grumpybear |
clients | object | --- |
@Type | string | --- Example: Clients |
clients | Array of object | --- |
@Type | string | --- Example: Client |
name | string | --- Example: --- |
id | string | --- Example: 68b887c7-1ac2-40a4-b70b-117a8ec34abf |
links | Array of object | --- |
rel | string | --- Example: self |
uri | string | --- Example: https://apiqa.tal.deere.com/platform/users/grumpybear |
boundaries | Array of object | --- |
@Type | string | --- Example: Boundary |
name | string | --- Example: Auto-Generated 2014 Harvest |
sourceType | string | --- Example: Auto |
modifiedTime | string | --- Example: 2016-11-17T11:53:00.000Z |
area | object | --- |
@Type | string | --- Example: MeasurementAsDouble |
valueAsDouble | number | --- Example: 7.502938 |
vrDomainId | string | --- Example: vrEastShiftComponent |
unit | string | The unit of measure for this value Example: ha |
workableArea | object | --- |
@Type | string | --- Example: MeasurementAsDouble |
valueAsDouble | number | --- Example: 7.502938 |
vrDomainId | string | --- Example: vrEastShiftComponent |
unit | string | The unit of measure for this value Example: ha |
multipolygons | Array of undefined | --- |
@Type | string | --- Example: Polygon |
rings | Array of object | --- |
@Type | string | --- Example: Ring |
points | Array of object | --- |
@Type | string | --- Example: Point |
lat | number | The latitude of the point Example: 43.6187 |
lon | number | The longitude of the point Example: 116.2146 |
type | string | --- Example: exterior |
passable | boolean | --- |
extent | object | --- |
@Type | string | --- Example: Extent |
topLeft | object | --- |
@Type | string | --- Example: Point |
lat | number | The latitude of the point Example: 43.6187 |
lon | number | The longitude of the point Example: 116.2146 |
bottomRight | object | --- |
@Type | string | --- Example: Point |
lat | number | The latitude of the point Example: 43.6187 |
lon | number | The longitude of the point Example: 116.2146 |
id | string | --- Example: 9369f3f6-2428-4bba-bf64-0a19cdaf007d |
links | Array of object | --- |
rel | string | --- Example: self |
uri | string | --- Example: https://apiqa.tal.deere.com/platform/users/grumpybear |
active | boolean | Whether or not this boundary is currently in use. A field with associated boundaries will have exactly one active boundary; however, a field may also exist with no boundaries. |
irrigated | boolean | Indicates whether the contained area is irrigated |
accessPoints | Array of object | --- |
id | string | --- |
description | string | --- |
direction | string | --- |
isEntry | boolean | --- |
isExit | boolean | --- |
location | object | --- |
@Type | string | --- Example: Point |
lat | number | The latitude of the point Example: 43.6187 |
lon | number | The longitude of the point Example: 116.2146 |
name | string | --- |
links | Array of object | --- |
rel | string | --- Example: self |
uri | string | --- Example: https://apiqa.tal.deere.com/platform/users/grumpybear |
guidanceLines | Array of object | --- |
@Type | string | --- Example: AbLine |
heading | number | --- Example: 356.5847091769351 |
aPoint | object | --- |
@Type | string | --- Example: Point |
lat | number | The latitude of the point Example: 43.6187 |
lon | number | The longitude of the point Example: 116.2146 |
bPoint | object | --- |
@Type | string | --- Example: Point |
lat | number | The latitude of the point Example: 43.6187 |
lon | number | The longitude of the point Example: 116.2146 |
eastShift | object | --- |
@Type | string | --- Example: MeasurementAsDouble |
valueAsDouble | number | --- Example: 7.502938 |
vrDomainId | string | --- Example: vrEastShiftComponent |
unit | string | The unit of measure for this value Example: ha |
northShift | object | --- |
@Type | string | --- Example: MeasurementAsDouble |
valueAsDouble | number | --- Example: 7.502938 |
vrDomainId | string | --- Example: vrEastShiftComponent |
unit | string | The unit of measure for this value Example: ha |
tramOffset | integer | --- Example: 0 |
tramSpacing | integer | --- Example: 0 |
savedMethod | string | --- Example: dtiABLineMethodBPoint |
id | string | --- Example: 5a62177b33df3c0e2cc85dc2 |
guid | string | --- Example: c2878a14-f9f4-4eaf-b7ef-24f3da95d337 |
name | string | --- Example: Fleece |
lastModifiedTime | string | --- Example: 2018-03-05T14:56:57.295Z |
status | string | --- Example: ACTIVE |
locked | boolean | --- |
links | Array of object | --- |
rel | string | --- Example: self |
uri | string | --- Example: https://apiqa.tal.deere.com/platform/users/grumpybear |
lastFieldOperation | object | --- |
@Type | string | --- Example: FieldOperation |
fieldOperationType | string | --- Example: seeding |
adaptMachineType | string | --- Example: unknown |
cropSeason | integer | --- Example: 2016 |
startDate | --- | --- Example: 2016-05-12T17:58:39.000Z |
endDate | --- | --- Example: 2016-05-12T17:59:42.400Z |
cropName | string | --- Example: CORN_WET |
id | string | --- Example: MjUxNDU3XzU5NjUzNjliN2U4MWQzMGM0ODFhMDdhYg |
links | Array of object | --- |
rel | string | --- Example: self |
uri | string | --- Example: https://apiqa.tal.deere.com/platform/users/grumpybear |
archived | boolean | --- Example: true |
flags | Array of object | --- |
@Type | string | --- Example: GenericNote |
createdDate | string | --- Example: 2016-08-19T18:48:48.886Z |
lastModifiedDate | string | --- Example: 2016-08-19T18:48:48.886Z |
text | string | --- Example: some text |
metadata | Array of object | --- |
@Type | string | --- Example: Metadata |
name | string | --- Example: EARLY_GROWTH_EMERGENCE |
value | integer | --- Example: 9 |
author | Array of object | --- |
@Type | string | --- Example: User |
accountName | string | --- Example: scoutcarla1 |
givenName | string | --- Example: scoutcarla1 |
familyName | string | --- Example: scoutcarla1 |
geometry | object | --- |
coordinates | Array of string | --- |
type | string | --- Example: Point |
noteType | string | --- Example: SCOUT |
id | string | --- Example: 4e7a1fa7-9db9-45ea-94d3-e45b2fa43c2a |
links | Array of object | --- |
rel | string | --- Example: self |
uri | string | --- Example: https://apiqa.tal.deere.com/platform/users/grumpybear |
id | string | --- Example: 9369f3f6-2428-4bba-bf64-0a19cdaf007d |
lastModifiedTime | string | --- Example: 2020-09-21T15:41:15.205Z |
links | Array of object | --- |
rel | string | --- Example: self |
uri | string | --- Example: https://apiqa.tal.deere.com/platform/users/grumpybear |
Sample Response [JSON]
Content-Type: application/vnd.deere.axiom.v3+json
x-deere-signature: 3b5392615e4b4e1c92013026f47109bb
{ "links": [ { "rel": "self", "uri": "https://sandboxapi.deere.com/platform/organizations/123456/fields" } ], "total": 1, "values": [ { "@type": "Field", "name": "01", "archived": false, "id": "d61b83f4-3a12-431e-8010-596f2466dc27", "links": [ { "@type": "Link", "rel": "self", "uri": "https://sandboxapi.deere.com/platform/organizations/123456/fields/d61b83f4-3a12-431e-8010-596f2466dc27" }, { "@type": "Link", "rel": "clients", "uri": "https://sandboxapi.deere.com/platform/organizations/123456/fields/d61b83f4-3a12-431e-8010-596f2466dc27/clients" }, { "@type": "Link", "rel": "notes", "uri": "https://sandboxapi.deere.com/platform/organizations/123456/fields/d61b83f4-3a12-431e-8010-596f2466dc27/notes" }, { "@type": "Link", "rel": "farms", "uri": "https://sandboxapi.deere.com/platform/organizations/123456/fields/d61b83f4-3a12-431e-8010-596f2466dc27/farms" }, { "@type": "Link", "rel": "owningOrganization", "uri": "https://sandboxapi.deere.com/platform/organizations/123456" }, { "@type": "Link", "rel": "boundaries", "uri": "https://sandboxapi.deere.com/platform/organizations/123456/fields/d61b83f4-3a12-431e-8010-596f2466dc27/boundaries" }, { "@type": "Link", "rel": "simplifiedBoundaries", "uri": "https://sandboxapi.deere.com/platform/organizations/123456/fields/d61b83f4-3a12-431e-8010-596f2466dc27/boundaries?simple=true" }, { "@type": "Link", "rel": "activeBoundary", "uri": "https://sandboxapi.deere.com/platform/organizations/123456/fields/d61b83f4-3a12-431e-8010-596f2466dc27 /boundaries/e7ab3a06-06ca-4d34-8cb7-6fd2a3640a3d" }, { "@type": "Link", "rel": "fieldOperation", "uri": "https://sandboxapi.deere.com/platform/organizations/123456/fields/d61b83f4-3a12-431e-8010-596f2466dc27 /fieldOperations" }, { "@type": "Link", "rel": "mapLayerSummaries", "uri": "https://sandboxapi.deere.com/platform/organizations/123456/fields/d61b83f4-3a12-431e-8010-596f2466dc27/mapLayerSummaries" }, { "@type": "Link", "rel": "lastFieldOperation", "uri": "https://sandboxapi.deere.com/platform/organizations/123456/fields/d61b83f4-3a12-431e-8010-596f2466dc27/fieldOperations?lastFieldOperation=true" }, { "@type": "Link", "rel": "contributionDefinition", "uri": "https://sandboxapi.deere.com/platform/contributionDefinitions/32a256ea-0000-4756-b000-b6dabda856ef" } ] } ] }