Modifier une annotation

PATCH /annotations/{id}

Scope annotations:write
Clé API x-api-key
URL de base https://api.hub.akuasense.com/v1

chart_type, type et unit sont figés à la création. ⚠️ content, style et text écrivent un contenu NEUF : text seul efface le style — renvoyez les deux. Déplacer la ligne d’un point de flétrissement déplace le seuil de son alerte. Un tracé qui n’est pas en vwc ne peut pas devenir un seuil (THRESHOLD_REQUIRES_VWC).

Paramètres de chemin

id string uuid obligatoire

En-têtes

Idempotency-Key string

Rejoue la même réponse 2xx (24 h)

Corps de la requête

p1 tableau d’any

Un point de la courbe, [instant, valeur] : l’instant en millisecondes depuis le 1er janvier 1970 UTC, la valeur dans l’unité de l’annotation (unit ; en humidité, % de VWC par défaut).
p2 tableau d’any

Un point de la courbe, [instant, valeur] : l’instant en millisecondes depuis le 1er janvier 1970 UTC, la valeur dans l’unité de l’annotation (unit ; en humidité, % de VWC par défaut).
content object

Style et texte : { style, text }. Remplace le contenu entier.
style object

Raccourci, écrit dans content.style.
text string

Raccourci, écrit dans content.text.

Réponse

200

Annotation modifiée

id string uuid toujours présent
module_id integer toujours présent
probe_id any peut être null toujours présent

Obsolète : toujours null.
chart_type string toujours présent

Courbe du hub qui porte l’annotation. humidity : courbe de synthèse, l’humidité pondérée — c’est elle qui porte les seuils agronomiques. humidity-detail : humidité par profondeur. humidity-heatmap : carte de chaleur. temperature : température. tensio : sonde tensiométrique (tension reste accepté en entrée).

Valeurs : humidityhumidity-detailhumidity-heatmaptemperaturetensio
type string toujours présent

Forme du tracé, telle que la dessinent les outils du hub : h-line (ligne horizontale), v-line (verticale), segment, ray (demi-droite), infinite (droite), arrow, h-free, rect (zone), text. D’anciennes annotations portent line.
p1 tableau d’any toujours présent

Un point de la courbe, [instant, valeur] : l’instant en millisecondes depuis le 1er janvier 1970 UTC, la valeur dans l’unité de l’annotation (unit ; en humidité, % de VWC par défaut).
p2 tableau d’any peut être null toujours présent

Second point, pour les tracés qui en ont deux.
unit string peut être null toujours présent

Unité de la hauteur des points (p1, p2), c’est-à-dire la vue de la courbe à laquelle l’annotation appartient : elle ne s’affiche que dans cette unité. Courbes humidity et humidity-detail seulement : vwc — humidité volumique, %, l’unité de référence, celle de l’alerte et de l’état hydrique —, vwc_max — part de la saturation du sol, % —, mm. null sur les autres courbes, qui n’ont qu’une unité.

Valeurs : vwcvwc_maxmmnull
content object toujours présent

Style et texte du tracé : { style, text }.
user_id string toujours présent

Auteur : userId d’un membre (GET /company/users).
created_at string date-time toujours présent
updated_at string date-time toujours présent
style object

Copie de content.style, présente quand il existe.
text string

Copie de content.text, présente quand il existe.

Erreurs

400
Saisie refusée

THRESHOLD_REQUIRES_VWC
401
Non authentifié
403
Scope/rôle insuffisant ou hors société
404
Annotation introuvable

not_found

PATCH /annotations/{id}

curl -X PATCH https://api.hub.akuasense.com/v1/annotations/c98af727-6006-4f97-a498-ffe04b997b93 \
  -H "x-api-key: VOTRE_CLE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "p1": [
      1781208270784.069,
      11
    ],
    "p2": [
      1781208270784.069,
      11
    ]
  }'

const response = await fetch(
  'https://api.hub.akuasense.com/v1/annotations/c98af727-6006-4f97-a498-ffe04b997b93',
  {
    method: 'PATCH',
    headers: {
      'x-api-key': 'VOTRE_CLE_API',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      "p1": [
        1781208270784.069,
        11
      ],
      "p2": [
        1781208270784.069,
        11
      ]
    }),
  },
);
const data = await response.json();

import requests

response = requests.patch(
    "https://api.hub.akuasense.com/v1/annotations/c98af727-6006-4f97-a498-ffe04b997b93",
    headers={"x-api-key": "VOTRE_CLE_API"},
    json={
        "p1": [
            1781208270784.069,
            11,
        ],
        "p2": [
            1781208270784.069,
            11,
        ],
    },
)
data = response.json()

Réponse

{
  "id": "c98af727-6006-4f97-a498-ffe04b997b93",
  "module_id": 145,
  "probe_id": null,
  "chart_type": "humidity",
  "type": "h-line",
  "p1": [
    1781208270784.069,
    11
  ],
  "p2": [
    1781208270784.069,
    11
  ],
  "unit": "vwc",
  "content": {
    "style": {
      "fill": "threshold2",
      "stroke": "var(--destructive)",
      "lineDash": "dashed",
      "lineWidth": 2
    }
  },
  "user_id": "cmf8x2k4q0002js08h4m2c8kv",
  "created_at": "2026-06-18T19:51:08.446Z",
  "updated_at": "2026-06-18T19:51:29.699Z",
  "style": {
    "fill": "threshold2",
    "stroke": "var(--destructive)",
    "lineDash": "dashed",
    "lineWidth": 2
  }
}

application/json

{
  "type": "string",
  "title": "string",
  "status": 400,
  "detail": "string",
  "code": "THRESHOLD_REQUIRES_VWC"
}

application/problem+json · exemple généré depuis le schéma

{
  "type": "string",
  "title": "string",
  "status": 401,
  "detail": "string",
  "code": "string"
}

application/problem+json · exemple généré depuis le schéma

{
  "type": "string",
  "title": "string",
  "status": 403,
  "detail": "string",
  "code": "string"
}

application/problem+json · exemple généré depuis le schéma

{
  "type": "string",
  "title": "string",
  "status": 404,
  "detail": "string",
  "code": "not_found"
}

application/problem+json · exemple généré depuis le schéma