Details of the REST API
The Geoportal extension REST interface follows the design of the ArcGIS Server REST API.
Requests sent to the Geoportal REST API must conform to the following pattern:
http://machineName/GeoportalAppName/rest/find/document?requestParameter(s)
For requests that have more than one parameter, the parameters must be concatenated using theampersand (&) symbol, as such: http://machineName/GeoportalAppName/rest/find/document?requestParameter1&requestParameter2&...
The table below lists the parameters that are available in the REST API. For a full description of each parameter, refer to the com.esri.gpt.control.georss package in the
Geoportal extension Javadoc.
| Parameter |
Function |
Accepted Values |
| bbox |
Query by extent specified as two pairs of coordinates (west-south and east-north) |
Comma-delimited string of integers between -180,180 and -90, 90. |
| spatialRel |
Query by spatial relationship. Used in conjunction with bbox parameter. |
String value. One of esriSpatialRelWithin (default), esriSpatialRelOverlaps. |
| searchText |
Query by keyword |
String value representing a keyword. |
| contains |
Keyword concatenation options. NOTE: this parameter is supported through the Lucene syntax instead of the standard 'contains' values of exact, any or all. |
For an exact match use double quotes. For example, see the syntax for two terms, Hawaii and Quads:
- Exact: "hawaii Quads"
- Any: hawaii Quads
- All: +hawaii+Quads
e.g:http://serverName/geoportal/rest/find/document?searchText="hawaii Quads"&f=georss |
| contentType |
Query by content type |
String value representing an ArcIMS content type. See Javadoc for complete list. |
| dataCategory |
Query by data category (ISO 19115 themes) |
Comma-delimited list of strings. Keywords identified by the ISO 19115 specification. See JavaDoc for complete list. |
| after, before |
Query by date |
Date string in the format yyyy-mm-dd |
| orderBy |
Result sort options |
String value. One of areaAscending, areaDescending, dateAscending, dateDescending (default), format, relevance, title. |
| max |
Specify max number of records to retrieve |
Integer. Default: 10. |
| geometryType |
Defines how spatial data will be represented |
String value. One of esriGeometryPoint, esriGeometryPolygon (default), esriGeometryBox |
| f |
Output format of results |
String value. One of georss (default), kml, html, htmlfragment, json, pjson |
| style |
CSS stylesheet for HTML results |
String value representing a URL to a stylesheet. |
| target |
Behaviour of links (open in same or new window) |
String value. One of blank (default), parent, self, top. |
