Paddocks

Get a paddock

One paddock: its name, area_ha with its area_source, land use, crop, archive state, its diary counters (record_count, open_task_count), and its outline. The owning property is the farm relationship, and block_id is the block it sits in inside that property (null for the home block; the block's name and members are the property's blocks). withholding is the grazing or harvest withholding period still ahead, from the paddock's completed sprays and from the seed treatments of a completed sowing, or null when the paddock is clear. Fertiliser and field work do not change it. The same fact for every asset on the property is getFarmStatus.

boundary is an array of closed rings, each an array of [longitude, latitude] pairs — longitude first, never a GeoJSON object — or null while the paddock is known by name only (has_boundary: false); boundary_source says how the ring was captured. Write it with updatePaddockBoundary. Everything filed on it — the property, its tasks and records, moves that name it, and the mobs standing in it — is listAssetResources with asset_type=paddock. The task board alone is listTasks with asset_id. Any accepted member of the owning organization can read; a personal property is its owner's.

get/paddocks/{id}

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/paddocks/{id}
  • Auth: one of:
    • none
    • HTTP bearer

Path parameters

idstring required

Id of the record

Query parameters

includestring
Example:farm.organization

Comma-separated snake_case relationship paths to embed (JSON:API included array, or inlined for application/json). Never embedded by default; unknown paths ignored; dot notation selects children; max 10 paths. Allowed paths: farm, farm.organization.

Response

Successful

Example response

{
  "data": {
    "type": "paddock"
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.