Versions Compared

Old Version 3

changes.mady.by.user Shinken Trainee

Saved on

compared with

New Version 4

changes.mady.by.user Shinken Trainee

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scroll Ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmlfalse
Panel
titleSommaire

Table of Contents
stylenone

Concept

/list?filter=name:XXXXX~state:published^^draft

  • UUID et nom des météos existantes
    • Publié ou non

Méthode GET permettant de lister les vues météos actuellement créées, comme dans l'Interface de Visualisation.

Les paramètres

Nom et formatValeur par défautDescription et Syntaxe

filter=expression~expression~...

---

  • ~ ayant le sens de "et" 
  • expression de la forme :  critère:valeur0^^valeur1 
    • où ^^ a le sens de "ou"

Les critères disponibles sont :

  • name : Filtrer par le nom de la vue ( insensible à la casse ).
  • state : Filtrer par l'état de la vue :
    • draft : Météo en construction.
    • published : Météo publiée.
Les paramètres

Réponse

Codes de retour

Codes de retourExplications
200

OK

400

Paramètre invalide

401

L'accès nécessite une authentification ou un Token valide.

403

Authentification de l'utilisateur OK, mais droits non suffisants.

500

L'appel est valide, mais un problème d'exécution est rencontré.

Retour du code 200

Retour du code 400

Code Block
languagetext
themeEmacs
curl -s -S -U 'username:password' \
http://webui:7767/external-api/service-weather/v1/list


Exemple de sortie attendue :

Code Block
languagebash
themeRDark
titlehttp://localhost:7767/external-api/service-weather/v1/list
collapsetrue
{
  "output": {
    "views": [
      {
        "uuid": "ab512c70e84a4c7a9b0e23b46eec5355",
        "name": "Bordeaux",
        "state": "draft"
      },
      {
        "uuid": "cc30ce13004d41ada2d3f765fab680e3",
        "name": "Paris",
        "state": "published"
      }
    ]
  }
}

Retour du code 400

  • Mêmes erreurs que dans l'interface ( dans la langue de l'interface )
  • Même comportement que l'interface : On peut sauvegarder la vue si l'interface l'aurait autorisé.
    • Code d'erreur HTTP cohérent

    Paramètres POST incorrects

    Paramètre inconnu

    Messages d'erreurs des filtres 

    Excerpt Include
    V1 - Les erreurs communes lors de l'envoi de la requête à /external-api/service-weather/v1
    V1 - Les erreurs communes lors de l'envoi de la requête à /external-api/service-weather/v1
    nopaneltrue

    ...