Blocks

Group paddocks into a block

Names a block on the property and, with paddock_ids, puts those live paddocks of the property in it ("Group into a block"); each member's block_id becomes the block's id. A block is a label for where paddocks sit: it has no page and no records of its own, and grouping writes, moves or removes no record. A paddock carries one block, so a paddock already in another block moves to this one. Reading the property then lists it under blocks, with its area and outline derived from the members.

Requires edit rights on the property. /farms/{farm_id}/blocks is a deprecated alias for one release.

post/properties/{property_id}/blocks

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/properties/{property_id}/blocks
  • Auth: HTTP bearer

Path parameters

property_idstring uuid required

The property's id.

Request body

Response

The new block.

Example response

{
  "data": {
    "type": "block"
  }
}

Changes

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