View Source

Concept

Méthode GET permettant de récupérer la structure d'une vue météo.

La structure retournée est la même que celle visible dans l'onglet "JSON" du mode édition d'une vue météo dans l'Interface de Visualisation ( voir la page Édition JSON - Météo ).

Les paramètres

Le paramètre ID reçu dans l'URL identifie la vue météo à rechercher.

Réponse

Codes de retour

Codes de retour	Explications
200	OK
401	L'accès nécessite une authentification ou un Token valide.
403	Authentification de l'utilisateur OK, mais droits non suffisants.
404	La vue météo n'existe pas.
500	L'appel est valide, mais un problème d'exécution est rencontré.

Retour du code 200

curl -s -S -U 'username:password' \
"http://webui:7767/external-api/service-weather/v1/get/WEATHER_UUID"

Exemple de sortie attendue :

{
  "critical": [],
  "errors": [],
  "warnings": [],
  "output": {
    "view_info": {
      "name": "Bordeaux",
      "state": "draft",
      "type": "service_weather",
      "weather_uuid": "ab512c70e84a4c7a9b0e23b46eec5355",
      "weather_version": 2,
      "weather_format_version": 5,
      "weather_shared_group": "service_weather",
      "weather_creation_time": 1787666586.1508853
    },
    "view_json": {
       ...
    }
  }
}

Messages de validation

Les messages d'erreurs et d'attention liées à la vue seront dans les champs critical, errors et warnings respectivement ( voir la page Gestion des problèmes de configuration - Édition - Météo ).

Exemple avec un widget météo non configuré :

{
  "critical": [],
  "errors": [],
  "warnings": [
    {
      "text": "La valeur pour la clé [ item_type ] est obligatoire. Les valeurs possibles sont [ host, cluster ]",
      "property": "grids.0.grid_elements.2.content.item",
      "fields_with_errors": [
        "item_type"
      ]
    },
    {
      "text": "Au moins une des deux clés suivantes doit être renseignée : [ item_uuid ] ou [ item_name ]",
      "property": "grids.0.grid_elements.2.content.item",
      "fields_with_errors": [
        "item_uuid",
        "item_name"
      ]
    }
  ],
  "output": {
    "view_info": {
      "name": "Bordeaux",
      "state": "draft",
      "type": "service_weather",
      "weather_uuid": "ab512c70e84a4c7a9b0e23b46eec5355",
      "weather_version": 2,
      "weather_format_version": 5,
      "weather_shared_group": "service_weather",
      "weather_creation_time": 1787666586.1508853
    },
    "view_json": {
       ...
    }
  }
}

Le champ property permet de savoir à quel endroit dans le JSON se trouve l'erreur afin de la corriger.

Retour du code 404

curl -s -S -U 'username:password' \
"http://webui:7767/external-api/service-weather/v1/get/unknown_uuid"

{
  "output": "Weather with uuid [ unknown_uuid ] was not found"
}