Kaax
InícioEntrar
Referencia

Templates de relatório

Definem como um relatório se parece: quais estatísticas leva, em qual layout e com qual escala de cor. Uma configuração as referencia por id.

GET/api/v2/templates

Os templates da conta.

Parámetros

analysisTypestringopcionalcounting · replanting · path

Filtra por tipo de análise.

reportTypestringopcional

Filtra por reportType exato.

reportCategorystringopcionalgeneral · vegetation_index

Filtra por categoria.

pageintegeropcionaldefault 1

Página, começando em 1.

limitintegeropcionaldefault 20 · max 100

Resultados por página.

GET/api/v2/templates/presets

Templates iniciais, cada um com um seedPayload pronto para POSTar.

A tener en cuenta

  • O caminho que funciona na primeira: pegue um preset, sobrescreva `name` e POSTe. Escrever `layouts` à mão é escrever coordenadas normalizadas 0..1 aninhadas.
POST/api/v2/templates

Cria um template. Devolve 201 com o documento serializado.

A tener en cuenta

  • Conta contra o limite de templates do plano, compartilhado entre o dono e todos os sub-usuários.
  • Um 400 traz o detalhe por campo em `issues` — leia, diz exatamente o que foi recusado.
GET/api/v2/templates/{id}

Um template por id.

PUT/api/v2/templates/{id}

Substitui o template completo.

A tener en cuenta

  • É uma SUBSTITUIÇÃO, não uma fusão: envie o documento inteiro. Uma fusão parcial sobre `layouts` deixa um layout pela metade que renderiza errado.
  • `userId` no corpo é ignorado. A propriedade não é reatribuível.
DELETE/api/v2/templates/{id}

Apaga o template.

POST/api/v2/templates/validate-formula

Valida uma fórmula de Custom_Index contra o mesmo parser que o servidor aplica, e informa se usa L.

Parámetros

formulastringobrigatório

A expressão a validar. Máximo de 2000 caracteres.

Resposta

json
{
  "valid": true,
  "usesL": true
}

A tener en cuenta

  • Valide ANTES de criar. Caso contrário o único sinal é um template recusado, que se lê como «o template está errado» e não «a fórmula está».
  • `usesL: true` significa que o template também precisa de `saviL`.