View Farms in an Org
GET
Request URI
GET https://sandboxapi.deere.com/platform/organizations/{orgId}/farms
Accept: application/vnd.deere.axiom.v3+json
Parameters
Parameter | Type | Description & Example | In |
---|---|---|---|
embed | string | Embed additional traceability record metadata to response Example: showRecordMetadata | query |
RecordFilter | string | Allows filtering based on archived status Example: archived Allowed Values: available,archived,all | query |
orgId Required | integer | The id of the organization Example: 12345 | path |
Response Details
Field | Type | Description & Example |
---|---|---|
@type | string | --- Example: Farm |
name | string | Farm Name Example: John Doe |
id | string | Farm Id Example: 9369f3f6-2428-4bba-bf64-0a19cdaf007d |
archived | boolean | Archived Status Example: false |
clientUri | string | Client Uri Example: https://apiqa.tal.deere.com/platform/organizations/5555/clients/22b84b4c-b651-d554-a02b-89829cd5239c |
links | Array of object | --- |
Sample Response [JSON]
Content-Type: application/vnd.deere.axiom.v3+json
x-deere-signature: 5a5392615e4b4e1c92013026f47109bb
{ "links": [ { "rel": "self", "uri": "https://sandboxapi.deere.com/platform/organizations/6789/farms" } ], "total": 2, "values": [ { "name": "FarmName", "clientUri": "https://sandboxapi.deere.com/platform/organizations/592715/clients/e45d1773-cb82-468-96ac-ba65917dd274,", "archived": false, "id": "f1161eba-7c82-4a80-9eeb-383451b4c46e", "links": [ { "rel": "self", "uri": "https://sandboxapi.deere.com/platform/organizations/6789/farms/f1161eba-7c82-4a80-9eeb-383451b4c46e" }, { "rel": "fields", "uri": "https://sandboxapi.deere.com/platform/organizations/6789/farms/f1161eba-7c82-4a80-9eeb-383451b4c46e/fields" }, { "rel": "farms", "uri": "https://sandboxapi.deere.com/platform/organizations/6789/farms/f1161eba-7c82-4a80-9eeb-383451b4c46e/clients" }, { "rel": "owningOrganization", "uri": "https://sandboxapi.deere.com/platform/organizations/6789" } ] } ] }