REST-API-Details
Die Geoportal-REST-Schnittstelle entspricht dem Design der ArcGIS Server-REST-API. Über die REST-API können die lokal gehosteten Ressourcen und auch auf Remote-Repositories gehostete Ressourcen abgefragt werden. Diese zwei Szenarien werden unten dargestellt. In diesen Szenarien ist requestParameter ein Platzhalter für einen REST-Parameter. REST-Parameter werden weiter unten in diesem Thema erläutert.
- Verwenden Sie das folgende URL-Muster, um nur den lokalen Geoportal-Katalog abzufragen: http://machineName/geoportal/rest/find/document?requestParameter
- Zur Abfrage von Remote-Repositories verwenden Sie das folgende URL-Muster: http://machineName/geoportal/rest/distributed?rid=repositoryID&requestParameters. Der rid-Parameter dient in diesem Fall zur Identifikation des Repositorys, das durchsucht wird.
Bei Verwendung mehrerer rid -Parameter können Sie mehrere Repositories gleichzeitig durchsuchen. Verwenden Sie das folgende URL-Muster: http://machineName/geoportal/rest/distributed?rid=repositoryID1&rid=repositoryID2&requestParameter
Beispiel: http://exampleserver/geoportal/rest/distributed?rid=local&rid=ArcGIS.COM&start=1&max=10&orderBy=relevance&searchText=water&f=atom
In der nachfolgenden Tabelle sind die Parameter aufgelistet, die in der Geoportal-REST-API verfügbar sind. Eine vollständige Beschreibung aller Parameter finden Sie im Geoportal JavaDoc in den Paketen com.esri.gpt.control.georss und com.esri.gpt.control.rest.search. Bei Anfragen mit mehr als einem Parameter müssen die Parameter mit dem kaufmännischen Und-Zeichen (&) verbunden werden. Verwenden Sie das folgende URL-Muster: http://machineName/geoportal/rest/find/document?requestParameter1&requestParameter2&...
| requestParameter | Funktion | Akzeptierte Werte |
|---|---|---|
bbox | Abfrage nach Ausdehnung, die als zwei Koordinatenpaare angegeben wird (West-Süd und Ost-Nord) | Durch Kommas getrennte Zeichenfolge mit Ganzzahlen zwischen -180, 180 und -90, 90. |
spatialRel | Abfragen nach räumlicher Beziehung. Wird in Verbindung mit dem bbox-Parameter verwendet. | Zeichenfolgenwert. Einer der folgenden Werte: esriSpatialRelWithin (Standard), esriSpatialRelOverlaps. |
searchText | Abfrage nach Schlüsselwort | Zeichenfolgenwert, der ein Schlüsselwort darstellt. |
contains | Verkettungsoptionen für Schlüsselwörter. Dieser Parameter ist bei Verwendung der Lucene-Syntax veraltet. | Verwenden Sie für eine hundertprozentige Übereinstimmung doppelte Anführungszeichen. Sehen Sie sich als Beispiel die Syntax für die zwei Begriffe Hawaii und Quads an:
|
contentType | Abfrage nach Art des Inhalts | Zeichenfolgenwert, der Esri als Art des Inhalts darstellt. Eine vollständige Liste finden Sie im Javadoc. |
dataCategory | Abfrage nach Datenkategorie (ISO 19115-Themen) | Kommagetrennte Liste mit Zeichenfolgen. Über die ISO 19115-Spezifikation ermittelte Schlüsselwörter. Eine vollständige Liste finden Sie im Javadoc. |
after, before | Abfrage nach Datum | Datumszeichenfolge im Format JJJJ-MM-TT. |
orderBy | Optionen für die Ergebnissortierung | Zeichenfolgenwert. Einer der folgenden Werte: areaAscending, areaDescending, dateAscending, dateDescending (Standard), Format, Relevanz, Titel. |
max | Angabe der maximalen Anzahl der abzurufenden Datensätze. | Ganzzahl. Die Begrenzung für nicht qualifizierte Abfragen liegt bei max=100. Eine 'nicht qualifizierte Abfrage' ist eine Abfrage ohne festgelegte Suchparameter. Die Begrenzung für qualifizierte Abfragen liegt bei max=5000. Standardwert: 10. |
geometryType | Definieren der Darstellungsweise von räumlichen Daten. | Zeichenfolgenwert. Einer der folgenden Werte: esriGeometryPoint, esriGeometryPolygon (Standard), esriGeometryBox. |
f | Das Antwortformat | Zeichenfolgenwert. Eine der folgenden Optionen: georss (Standard), atom, json, kml, html, htmlfragment, csv (ab Version 1.2). |
Style | CSS-Stylesheet für HTML-Ergebnisse | Zeichenfolgenwert, der eine URL für ein Stylesheet darstellt. |
target | Verhalten von Links (in demselben oder in einem neuen Fenster geöffnet). | Zeichenfolgenwert. Einer der folgenden Werte: leer (Standard), Parent, selbst, oben. |
rid | Mit dem Repository verknüpfte ID. Für das Vergleichen von Ergebnissen zwischen verschiedenen Repositories sind mehrere rid-Parameter zulässig. | Zeichenfolgenwert. |
rids | Kommagetrennter rid. Kann anstelle mehrerer rid-Parameter verwendet werden. | Zeichenfolgenwerte. |
maxSearchTimeMilliSec | Maximale Zeit für das Abrufen von Ergebnissen. | Ganzzahl. Die Standardeinstellung ist 5000 Millisekunden. |