Fichier fields.xml : définir des variantes sur les champs transmis

Dans le cadre des requêtes sur l'API sur les fiches (type = fiche, type = q-fiche et type = geojson), il peut être utile de limiter le nombre de champs transmis (pour réduire la taille du fichier JSON résultant) ou de les renommer (par exemple, dans le cas du requête au format GeoJson insérée dans un système qui attend des noms de champs particuliers). Les paramètres fichefields et motclefields permettent de le faire du côté du client, le fichier de configuration fields.xml permet de le faire du côté du serveur.

Effectuer la configuration du côté serveur avec fields.xml simplifie la construction de la requête côté client, offre des possibilités de configuration plus vastes et permet de modifier le comportement par défaut.

Le fichier fields.xml permet de définir des « variantes ». Chaque variante a un nom, il suffit d'indiquer ce nom dans le paramètre fieldvariant disponible dans type = fiche, type = q-fiche et type = geojson pour indiquer la variante à utiliser. Trois variantes sont définies par défaut dans le logiciel avec les noms suivants :

• data : variante utilisée pour type = fiche
• query : variante utilisée pour type = q-fiche
• geo : variante utilisée pour type = geojson

Il suffit de définir dans fields.xml des variantes avec le nom d'une variante par défaut pour la remplacer.