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

Notes

PreviousCrops FamiliesNextSatellite Data Overview

Last updated 1 year ago

get
Path parameters
idstringRequired
Responses
get
GET /api/notes/{id}/ HTTP/1.1
Host: 
Accept: */*
200Success
{
  "id": 1,
  "user": {
    "id": 1,
    "username": "text",
    "first_name": "text",
    "last_name": "text"
  },
  "attachments": [
    {
      "id": 1,
      "attachment": "https://example.com",
      "created": "2025-04-27T15:29:13.106Z",
      "modified": "2025-04-27T15:29:13.106Z",
      "note": 1
    }
  ],
  "key": "123e4567-e89b-12d3-a456-426614174000",
  "reference_date": "2025-04-27T15:29:13.106Z",
  "note": "text",
  "geom": {
    "type": "GeometryCollection",
    "coordinates": [
      {
        "type": "Point",
        "coordinates": [
          12.9721,
          77.5933
        ]
      }
    ]
  },
  "parameters": null,
  "geometry": null,
  "created": "2025-04-27T15:29:13.106Z",
  "modified": "2025-04-27T15:29:13.106Z",
  "parcel": 1
}
delete
Path parameters
idstringRequired
Responses
delete
DELETE /api/notes/{id}/ HTTP/1.1
Host: 
Accept: */*
204

No response body

No content
  • GET/api/notes/
  • POST/api/notes/
  • GET/api/notes/{id}/
  • DELETE/api/notes/{id}/
get
Responses
get
GET /api/notes/ HTTP/1.1
Host: 
Accept: */*
200Success
[
  {
    "id": 1,
    "user": {
      "id": 1,
      "username": "text",
      "first_name": "text",
      "last_name": "text"
    },
    "attachments": [
      {
        "id": 1,
        "attachment": "https://example.com",
        "created": "2025-04-27T15:29:13.106Z",
        "modified": "2025-04-27T15:29:13.106Z",
        "note": 1
      }
    ],
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "reference_date": "2025-04-27T15:29:13.106Z",
    "note": "text",
    "geom": {
      "type": "GeometryCollection",
      "coordinates": [
        {
          "type": "Point",
          "coordinates": [
            12.9721,
            77.5933
          ]
        }
      ]
    },
    "parameters": null,
    "geometry": null,
    "created": "2025-04-27T15:29:13.106Z",
    "modified": "2025-04-27T15:29:13.106Z",
    "parcel": 1
  }
]
post
Body
idintegerRead-onlyRequired
keystring · uuidRead-onlyRequired
reference_datestring · date-time | nullableOptional
notestring · max: 2048Required
parametersany | nullableOptional
geometryany | nullableOptional
createdstring · date-timeRead-onlyRequired
modifiedstring · date-timeRead-onlyRequired
parcelintegerRequired
Responses
post
POST /api/notes/ HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 334

{
  "user": {
    "username": "text",
    "first_name": "text",
    "last_name": "text"
  },
  "attachments": [
    {
      "attachment": "https://example.com",
      "note": 1
    }
  ],
  "reference_date": "2025-04-27T15:29:13.106Z",
  "note": "text",
  "geom": {
    "type": "GeometryCollection",
    "coordinates": [
      {
        "type": "Point",
        "coordinates": [
          12.9721,
          77.5933
        ]
      }
    ]
  },
  "parameters": null,
  "geometry": null,
  "parcel": 1
}
201Success
{
  "id": 1,
  "user": {
    "id": 1,
    "username": "text",
    "first_name": "text",
    "last_name": "text"
  },
  "attachments": [
    {
      "id": 1,
      "attachment": "https://example.com",
      "created": "2025-04-27T15:29:13.106Z",
      "modified": "2025-04-27T15:29:13.106Z",
      "note": 1
    }
  ],
  "key": "123e4567-e89b-12d3-a456-426614174000",
  "reference_date": "2025-04-27T15:29:13.106Z",
  "note": "text",
  "geom": {
    "type": "GeometryCollection",
    "coordinates": [
      {
        "type": "Point",
        "coordinates": [
          12.9721,
          77.5933
        ]
      }
    ]
  },
  "parameters": null,
  "geometry": null,
  "created": "2025-04-27T15:29:13.106Z",
  "modified": "2025-04-27T15:29:13.106Z",
  "parcel": 1
}