Graniot API
  • Welcome!
  • Quick Start
  • Embedded Maps
  • Reference
    • API Reference
      • Accounts
      • Farms
        • Farm Managers
      • Parcels
        • Satellite Data
        • Plants
        • Crops
        • Weather Forecast
        • Historical weather data
      • Crops Families
      • Notes
  • Satellite Sources
    • Satellite Data Overview
    • Available Data Sources
      • Sentinel-2
      • PlanetScope
      • SkySat
      • Pleiades
      • PlĂ©iades Neo
      • Maxar
Powered by GitBook
On this page
  1. Reference
  2. API Reference

Farms

PreviousAccountsNextFarm Managers

Last updated 1 year ago

This entity represents a farm with the specific attributes. Here's a revised brief description:

  • name: This field is a string representing the name of the farm. It serves as an identifier or label for the farm, allowing users or systems to reference it by a human-readable name.

  • type: The type field is a string indicating the classification or category of the farm.

  • is_active: A boolean value that denotes whether the farm is currently active. An active status implies that the farm is operational, engaging in agricultural activities or production.

get
Responses
get
GET /api/farms/ HTTP/1.1
Host: 
Accept: */*
200

No response body

No content
post
Responses
post
POST /api/farms/ HTTP/1.1
Host: 
Accept: */*
201Success
{
  "id": 1,
  "name": "text",
  "type": "ARR",
  "is_active": true,
  "farm_group": {
    "id": 1,
    "name": "text"
  },
  "total_hectares": "text"
}
get
Path parameters
idstringRequired
Responses
get
GET /api/farms/{id}/ HTTP/1.1
Host: 
Accept: */*
200

No response body

No content
patch
Path parameters
idstringRequired
Responses
patch
PATCH /api/farms/{id}/ HTTP/1.1
Host: 
Accept: */*
200

No response body

No content
get
Path parameters
idstringRequired
Responses
get
GET /api/farms/{id}/parcels/ HTTP/1.1
Host: 
Accept: */*
200

No response body

No content
  • GET/api/farms/
  • POST/api/farms/
  • GET/api/farms/{id}/
  • PATCH/api/farms/{id}/
  • GET/api/farms/{id}/parcels/