Skip to content

Block/Zone 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 Block / Zone

The entity "Block" is internally designated as "Zone". This is due to the fact that we technically do not distinguish between greenhouses and open fields. While with greenhouses the term "block" is common, so is "zone" in open field operations. Our Common Data API will return zone instead of block. This distinction does not make a difference when working with our APIs.

 `/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: blocks, isLoading } = useEntity("FarmOrganization", "zones");

JSON Format

{
    "fieldId": "558eacf3-0891-406d-bfba-59859a5251f5",
    "blockName": "Block 4",
    "shortName": "bl04",
    "area": 619.1,
    "areaUnit": "sqm",
    "fieldPercentage": null,
    "description": "East side, entry to the left",
    "length": 75.5,
    "lengthUnit": "m",
    "width": 8.2,
    "widthUnit": "m",
    "rows": null,
    "location": "{\"row\":2,\"column\":2}",
    "id": "42b8115e-4da3-40c6-99ff-5253f3ea95e6"
}

Properties

Property Type Description
fieldId UUID ID of the field the block is associated with
blockName String Display name of the block
shortName String Short name of the block
area Float Calculated based on the block's dimensions
areaUnit String Unit of measure for the area
fieldPercentage Float Currently not used
description String Descriptive text of the block
length Float Length of the block
lengthUnit String Unit of measure for the length
width Float Width of the block
widthUnit String Unit of measure for the width
rows Integer Currently unused
location Object Represents the location within a grid of blocks
id UUID ID of the current block