| Scroll Ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
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 format | Valeur par défaut | Description et Syntaxe |
|---|---|---|
filter0=expression~expression~... | --- |
Plusieurs filtres peuvent être utilisés ( filter0 , filter1, ...), chaque élément correspondant à au moins un des filtres sera retourné en résultat de la requête. S'il y a plusieurs filtres, les éléments correspondant au filtre0 seront retournés ainsi que les éléments correspondant au filtre1, ainsi que… |
filterX ( Filtres )
Les filtres ont pour formes :
- filterX=expression~expression
- ~ ayant le sens de "et"
- expression de la forme : critère:valeur0^^valeur1
- où ^^ a le sens de "ou"
- X vaut de 0 à 9.
- Chaque élément correspondant à au moins un des filtres sera retourné.
Liste des critères et leurs valeurs possibles:
| Nom | Matching | Type | Valeur | Exemple d’expression |
|---|---|---|---|---|
name | contient | Tableau | Filtrer par le nom de la vue. | bor^^paris |
state | correspond exactement | Tableau |
| draft^^published |
Réponse
Codes de retour
| Codes de retour | Explications |
|---|---|
| 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
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -s -S -U 'username:password' \
"http://webui:7767/external-api/service-weather/v1/list" |
Exemple de sortie attendue :
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"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
Paramètre de filtre inconnu
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -s -S -U 'username:password' \
"http://webui:7767/external-api/service-weather/v1/list?filter=unknown_key:value" |
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"output": "filtering[0]: invalid field name [ unknown_key ]"
} |
Valeur de filtre manquante
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -s -S -U 'username:password' \
"http://webui:7767/external-api/service-weather/v1/list?filter=name" |
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"output": "filtering[0]: missing value for field [ name ]"
} |
Paramètre "state": valeur invalide
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -s -S -U 'username:password' \
"http://webui:7767/external-api/service-weather/v1/list?filter=name" |
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"output": "filtering[0]: field [ state ] => Wrong value: ['unknown']"
} |
| Excerpt Include | ||||||
|---|---|---|---|---|---|---|
|