Détails de l'API REST
L'interface REST du Géoportail suit le design de l'API REST d'ArcGIS Server. Via l'API REST, il est possible de demander les ressources hébergées localement et également les ressources hébergées sur les référentiels à distance. Ces deux scénarios sont indiqués ci-dessous. Dans ces scénarios, requestParameter est un espace réservé pour un paramètre REST. Les paramètres REST seront traités plus tard dans cette rubrique.
- Pour demander le catalogue du géoportail local uniquement, utilisez le modèle d'url suivant : http://machineName/geoportal/rest/find/document?requestParameter
- Pour demander les référentiels à distance, utilisez le modèle d'url suivant : http://machineName/geoportal/rest/distributed?rid=repositoryID&requestParameters. Ici, le paramètre rid est l'identification du référentiel recherché.
En utilisant plusieurs paramètres rid, vous pouvez rechercher plusieurs référentiels en même temps. Utilisez le modèle d'url suivant : http://machineName/geoportal/rest/distributed?rid=repositoryID1&rid=repositoryID2&requestParameter
Voici un exemple : http://exampleserver/geoportal/rest/distributed?rid=local&rid=ArcGIS.COM&start=1&max=10&orderBy=relevance&searchText=water&f=atom
La table ci-dessous indique les paramètres qui sont disponibles dans l'API REST du Géoportail. Pour une description complète de chaque paramètre, reportez-vous aux paquetages com.esri.gpt.control.georss et com.esri.gpt.control.rest.search dans le Javadoc du Géoportail. Pour les demandes qui ont plus d'un paramètre, les paramètres doivent être concaténés à l'aide du symbole "&". Utiliser le modèle d'url suivant : http://machineName/geoportal/rest/find/document?requestParameter1&requestParameter2&...
| requestParameter | Fonction | Valeurs acceptées |
|---|---|---|
bbox | Requête par étendue spécifiée comme deux paires de coordonnées (ouest-sud et est-nord) | Chaîne de nombres entiers délimitée par une virgule entre - 180, 180 et - 90, 90. |
spatialRel | Requête par relation spatiale. Utilisée en conjonction avec le paramètre bbox. | Valeur de chaîne. Un d'esriSpatialRelWithin (valeur par défaut), esriSpatialRelOverlaps. |
searchText | Requête par mot-clé | Valeur de chaîne représentant un mot-clé. |
contient | Options de concaténation de mots-clés. Ce paramètre est obsolète dans la syntaxe Lucene. | Pour une correspondance parfaite, utiliser des guillemets doubles. Par exemple, voir la syntaxe des deux termes, Hawaï et quads :
|
contentType | Requête par type de contenu | Valeur de chaîne représentant un type de contenu ESRI. Voir Javadoc pour la liste complète. |
dataCategory | Requête par catégorie de données (thèmes ISO 19115) | Liste de chaînes délimitées par virgule. Mots-clés identifiés par la spécification ISO 19115. Voir JavaDoc pour la liste complète. |
après, avant | Requête par date | Chaîne de date dans le format aaaa-mm-jj. |
orderBy | Options de tri de résultats | Valeur de chaîne. Un d'areaAscending, areaDescending, dateAscending, dateDescending (valeur par défaut), format, pertinence, titre. |
max | Spécifiez le nombre max d'enregistrements à récupérer. | Nombre entier. Il existe une limite de max = 100 sur les requêtes non qualifiées. Une 'requête non qualifiée' est lorsqu'il n'y a aucun paramètre de recherche défini. La limite sur les requêtes qualifiées est max = 5 000. Valeur par défaut : 10. |
geometryType | Définit la manière dont les données spatiales seront représentées. | Valeur de chaîne. Un d'esriGeometryPoint, esriGeometryPolygon (valeur par défaut), esriGeometryBox. |
f | le format de réponse | Valeur de chaîne. Une des valeurs georss (valeur par défaut), atom, json, kml, html, htmlfragment ou csv (à compter de la version 1.2). |
style | Feuille de style CSS pour les résultats HTML | Valeur de chaîne représentant une URL vers une feuille de style. |
cible | Comportement des liens (ouvrir dans la même fenêtre ou dans une nouvelle). | Valeur de chaîne. Un de vide (valeur par défaut), parent, auto, haut. |
ID | rid associé au référentiel. Plusieurs paramètres rid sont autorisés pour comparer les résultats entre les différents référentiels | Valeur de chaîne. |
rids | Délimitée par virgulerid. Peut être utilisée à la place de plusieurs paramètres rid. | Valeurs de chaîne. |
maxSearchTimeMilliSec | Durée maximale autorisée pour récupérer les résultats. | Nombre entier. La valeur par défaut est 5 000 millisecondes. |
Vous avez un commentaire à formuler concernant cette rubrique ?