Skip To Content

REST-API-Syntax

Die REST-Schnittstelle des Geoportals entspricht dem Design der ArcGIS Server REST-API. Über die REST-API ist es möglich, lokal gehostete Ressourcen sowie Ressourcen in Remote-Repositorys abzufragen. Diese zwei Szenarien sind unten mit Platzhaltern für die REST-Parameter dargestellt.

  • Um nur den lokalen Geoportal-Katalog abzufragen, verwenden Sie das folgende URL-Muster: http://<hostName>/geoportal/rest/find/document?<requestParameter>
  • Um Remote-Repositorys abzufragen, verwenden Sie das folgende URL-Muster: http://<hostName>/geoportal/rest/distributed?rid=<repositoryID>&<requestParameters>. In diesem Beispiel wird rid verwendet, um die ID des zu durchsuchenden Repositorys anzugeben.

Sie können mehrere rid-Parameter verwenden, um mehrere Repositorys gleichzeitig zu durchsuchen. Dies geschieht mit dem folgenden URL-Muster: http://<hostName>/geoportal/rest/distributed?rid=<repositoryID1>&rid=<repositoryID2>&<requestParameter>. Beispiel: http://<hostName>/geoportal/rest/distributed?rid=local&rid=ArcGIS.COM&start=1&max=10&orderBy=relevance&searchText=water&f=atom.

In der folgenden Tabelle sind die in der REST-API des Geoportals verfügbaren Parameter aufgeführt. Eine vollständige Beschreibung der einzelnen Parameter finden Sie unter "com.esri.gpt.control.georss" und "com.esri.gpt.control.rest.search" in der Java-Dokumentation des Geoportals. Bei Anforderungen mit mehreren Parametern müssen die Parameter mithilfe des kaufmännischen Und-Zeichens (&) verbunden werden, z. B. http://<hostName>/geoportal/rest/find/document?<requestParameter1>&<requestParameter2>&...

requestParameterFunktionAkzeptierte 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

Abfrage der räumlichen 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

Option zur Schlagwortverkettung. Dieser Parameter ist in der Lucene-Syntax veraltet.

Verwenden Sie für eine genaue Übereinstimmung doppelte Anführungszeichen. Die Syntax für die beiden Begriffe Hawaii und Quadranten lautet beispielsweise:

  • Genau: "Hawaii Quadranten"
  • Einer von beiden: Hawaii Quadranten
  • Alle: +Hawaii+Quadranten
http://<hostName>/geoportal/rest/find/document?searchText="Hawaii quads"&f=georss

contentType

Abfrage nach Art des Inhalts

Zeichenfolgenwert, der einen ESRI Inhaltstyp darstellt. Eine vollständige Liste finden Sie in der Java-Dokumentation des Geoportals.

dataCategory

Abfrage nach Datenkategorie (ISO 19115-Themen)

Kommagetrennte Liste von Zeichenfolgen. Schlagwörter, die durch die ISO 19115-Spezifikation definiert sind. Eine vollständige Liste finden Sie in der Java-Dokumentation des Geoportals.

after, before

Abfrage nach Datum

Datenzeichenfolge 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. Das Limit für nicht qualifizierte Abfragen beträgt max=100. Eine nicht qualifizierte Abfrage liegt vor, wenn keine Suchparameter angegeben wurden. Das Limit für qualifizierte Abfragen beträgt max=5000. Die Standardeinstellung ist 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.

Ziel

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 verbundene ID. Es sind mehrere rid-Parameter für den Vergleich von Ergebnissen zwischen verschiedenen Repositorys zulässig.

Zeichenfolgenwert.

rids

Durch Komma getrennte rid. Kann anstelle mehrerer rid-Parameter verwendet werden.

Zeichenfolgenwerte.

maxSearchTimeMilliSec

Maximale Zeit für das Abrufen von Ergebnissen.

Ganzzahl. Die Standardeinstellung ist 5.000 Millisekunden.