Skip to content

Field Data

The following data structures are published by the platform. If you want to learn how to retrieve entities published by the platform, please refer section "Accessing Platform Data" in our introduction to the topic.

Entity Field

 `/api/v1.0/{orgId}/FarmOrgEntities/{moduleId}/{dataAreaEntityId}`
  • orgId represents the organization you want data from; in most cases it's the current organization
  • moduleId represents the ID of the module requesting the data; in most cases it's your module ID
  • dataAreaEntityId represent the ID of the entity you want to access; the user must have given consent ot the data area "Farm Organization Definition" for this call to be successful. (See Data Areas and Entities for details)
const { data: fields, isLoading } = useEntity("FarmOrganization", "fields");

JSON Format

{
    "farmId": "85da51ae-a97b-4546-8b38-abcdef123456",
    "name": "Greenhouse C21",
    "description": "Partially under re-construction",
    "fieldTechnologyId": "0035213b-3528-4265-8f12-61d5d075b026",
    "fieldCoverageId": "59aacddc-9454-4775-9e50-00c80082f68f",
    "fieldShadingId": "dd4af382-8107-4f74-a15e-abbc8a0b78ea",
    "fieldSowingId": "de7d7cdf-b37d-439b-bcce-8d038b95eb3c",
    "fieldSubstrateId": "d4afe0c8-9b86-4c62-ab94-a01f2a965ea2",
    "length": null,
    "width": null,
    "rows": null,
    "location": "{\"geometry\":{\"coordinates\":[[[19.12345123451234,49.12345123451234],[19.12345123451234,49.12345123451234],[19.12345123451234,49.12345123451234],[19.12345123451234,49.12345123451234],[19.12345123451234,49.12345123451234],[19.12345123451234,49.12345123451234]]],\"type\":\"Polygon\"},\"properties\":{\"_azureMapsShapeId\":\"32eec194-a61e-48e3-9c6d-7a8fa0784478\",\"fieldId\":\"7c465722-508f-45b3-9875-abcdef123456\",\"label\":\"test\"},\"type\":\"Feature\"}",
    "area": 892846.41,
    "tag": "ghc21",
    "fieldTypeId": "3740520d-ee1a-4f5d-afea-99fb2f5717cf",
    "id": "7c465722-508f-45b3-9875-abcdef123456"
}

Properties

Property Type Description
farmId UUID ID of the farm location the field is associated with
name String Display name of the field
description UUID Currently unused
fieldTechnologyId UUID Refers to the heating method (see CommonData API (/api/v1.0/fieldtechnologytype/dropdown) for details)
fieldCoverageId UUID Refers to the type of coverage (see CommonData API (/api/v1.0/fieldcoveragetype/dropdown) for details)
fieldShadingId UUID Refers to the type of shading (see CommonData API (/api/v1.0/fieldshadingtype/dropdown) for details)
fieldSowingId UUID Refers to the sowing type (see CommonData API (/api/v1.0/fieldsowingtype/dropdown) for details)
fieldSubstrateId UUID Refers to the substrate type (see CommonData API (/api/v1.0/fieldsubstratetype/dropdown) for details)
length Float Currently unused
width Float Currently unused
rows Integer Currently unused
location GeoJSON Represents the shape of the field
area Float Calculated area of the field base on its shape
tag String Short name of the field
fieldTypeId String Refers to the growing environment, i.e. open field or greenhouse (see CommonData API (for details) (/api/v1.0/growingenvironment/dropdown)
id String ID of the current field