Kaax
InicioEntrar
Referencia

Catálogos

Los valores que el resto de la API acepta. Se leen primero: un reportType o una estadística inventada produce un rechazo que nombra el campo pero no el conjunto válido.

GET/api/v2/catalogs/report-types

Los reportType válidos por tipo de análisis, con su id, etiqueta y estadísticas asociadas.

Respuesta

json
{
  "counting": [
    {
      "id": "3146878f-39c3-44f1-8a95-f2a17170a1d9",
      "key": "NDRE",
      "label": { "en": "NDRE", "es": "NDRE" },
      "statistics": ["viGlobalMedian", "viTotalPlants"],
      "reportCategory": "vegetation_index"
    }
  ],
  "replanting": [],
  "path": []
}

A tener en cuenta

  • El super admin de Kaax edita esta lista, así que no la codifiques: leela.
  • `key` es el valor que va en `reportType`; `id` es el que va en `reportTypeId`.
GET/api/v2/catalogs/statistics

Las claves de estadística que existen por tipo de análisis — el conjunto del que puede salir selectedStatistics.

GET/api/v2/catalogs/vegetation-index-defaults

Todo lo necesario para armar una plantilla de índice de vegetación sin adivinar: nombres de índice, escalas de color calibradas, layouts por defecto y la whitelist de fórmulas.

Respuesta

json
{
  "indexNames": ["NDVI", "NDWI", "EVI", "SAVI", "NDRE", "LCI", "Custom_Index"],
  "colorScales": { "NDRE": [ /* … */ ] },
  "accentColors": { "NDRE": "#27AE60" },
  "layouts": { "portrait": { /* … */ }, "landscape": { /* … */ } },
  "defaults": {
    "paperSize": "letter",
    "mapResolution": 150,
    "margins": { "top": 2, "right": 2, "bottom": 2, "left": 2 },
    "saviL": 0.5
  },
  "customFormula": {
    "allowedBands": ["R", "G", "B", "RE", "NIR"],
    "allowedScalars": ["eps", "L"],
    "allowedFunctions": ["sqrt", "abs"],
    "rules": { "divisionRequiresEps": true }
  }
}

A tener en cuenta

  • `mapResolution` viene como número. Copiarlo como texto ("150") es rechazado por el TIPO, y el mensaje nombra el campo pero no la razón.