La interfaz REST del Geoportal sigue el diseño de la API REST de ArcGIS Server. A través de API REST, es posible consultar los recursos alojados localmente y también los recursos alojados en repositorios remotos. A continuación, se muestran estas dos situaciones con marcadores de posición para los parámetros REST.
- Para consultar únicamente el catálogo del geoportal local, use este patrón de URL: http://<hostName>/geoportal/rest/find/document?<requestParameter>
- Para consultar repositorios remotos, use este patrón de URL: http://<hostName>/geoportal/rest/distributed?rid=<repositoryID>&<requestParameters>. En este ejemplo, rid se usa para especificar el Id. del repositorio que se busca.
Puede usar varios parámetros de rid para buscar varios repositorios al mismo tiempo con este patrón de URL: http://<hostName>/geoportal/rest/distributed?rid=<repositoryID1>&rid=<repositoryID2>&<requestParameter>. Por ejemplo, http://<hostName>/geoportal/rest/distributed?rid=local&rid=ArcGIS.COM&start=1&max=10&orderBy=relevance&searchText=water&f=atom.
La tabla que aparece a continuación muestra los parámetros disponibles en la API REST de Geoportal. Para obtener una descripción completa de cada parámetro, consulte los paquetes com.esri.gpt.control.georss y com.esri.gpt.control.rest.search en el JavaDoc del Geoportal. En el caso de solicitudes que tengan más de un parámetro, estos se deben concatenar con el símbolo et (&), por ejemplo, http://<hostName>/geoportal/rest/find/document?<requestParameter1>&<requestParameter2>&....
| requestParameter | Función | Valores aceptados |
|---|---|---|
bbox | Consulta por extensión especificada como dos pares de coordenadas (de oeste a sur y de este a norte) | La cadena de caracteres de números enteros delimitada por medio de comas entre -180,180 y -90, 90. |
spatialRel | Consulta por relación espacial. Se usa junto con el parámetro bbox. | Valor de la cadena de caracteres. Uno de los esriSpatialRelWithin (predeterminados), esriSpatialRelOverlaps. |
searchText | Consulta por palabra clave | El valor de la cadena de caracteres que representa una palabra clave. |
contiene | Opciones de concatenación de palabras clave. Este parámetro queda obsoleto con la sintaxis Lucene. | Para obtener una coincidencia exacta use comillas dobles. Por ejemplo, vea la sintaxis de dos términos, Hawái y cuadrangulares:
|
contentType | Consulta por tipo de contenido | Valor de la cadena de caracteres que representa un tipo de contenido de ESRI. Consulte el JavaDoc del Geoportal para obtener una lista completa. |
dataCategory | Consulta por categoría de datos (temas ISO 19115) | Lista de cadenas de caracteres delimitados por comas. Palabras clave identificadas a través de la especificación ISO 19115. Consulte el JavaDoc del Geoportal para obtener una lista completa. |
después, antes | Consulta por fecha | Cadena de caracteres de fecha en el formato aaaa-mm-dd. |
orderBy | Opciones para ordenar resultados | Valor de la cadena de caracteres. Uno de areaAscending, areaDescending, dateAscending, dateDescending (predeterminado), formato, relevancia, título. |
máx. | Especifique el número máximo de registros a recuperar. | Entero. Hay un límite máximo de=100 en consultas no calificadas. Una consulta no calificada es cuando no se han establecido parámetros de búsqueda. El límite en consultas cualificadas es max=5000. El valor predeterminado es 10. |
geometryType | Define cómo se representarán los datos espaciales. | Valor de la cadena de caracteres. Uno de esriGeometryPoint, esriGeometryPolygon (predeterminado), esriGeometryBox. |
f | el formato de respuesta | Valor de la cadena de caracteres. Uno de georss (predeterminado), atom, json, kml, html, htmlfragment o csv (desde la versión 1.2). |
estilo | Hoja de estilo CSS para resultados HTML | El valor de la cadena de caracteres que representa una URL en una hoja de estilo. |
objetivo | Comportamiento de los vínculos (abiertos en la misma ventana o en una nueva). | Valor de la cadena de caracteres. Uno en blanco (predeterminado), primario, propio, superior. |
rid | Id asociada con el repositorio. Se permiten varios parámetros rid para comparar los resultados entre los diferentes repositorios | Valor de la cadena de caracteres. |
rids | rid delimitado por comas. Se puede utilizar en lugar de varios parámetros rid. | Valores de la cadena de caracteres. |
maxSearchTimeMilliSec | Período máximo de tiempo permitido para recuperar resultados. | Entero. El valor predeterminado es 5.000 milésimas de segundo. |