Parameter name | Type | Description |
---|
fields | Comma separated alpha-numeric string | Comma separated list of columns to return. Supports chained fields. |
showSchema | Boolean | Set to true to see all the field definitions in the response layers. Default: true |
output | String | The output type for the page. Possible types include 'XML', 'JSON', 'JSONXML', 'HTML', 'CSV', 'excel.sheet', and 'CUSTOM'. |
obsId | String | (Required for JSON/JSONXML output) The object listening for the JSON callback. |
obsSuccessMethod | String | (Required for JSON/JSONXML output) The JSON success callback function. |
obsErrorMethod | String | (Required for JSON/JSONXML output) The JSON error callback function. |
transformer | String | (Required for CUSTOM output) The XSLT to use to transform the XML output. |
dataSource | Comma separated alpha-numeric string | (Required) The name of the data source to query against. |
inclusionGeometries | String | Semi-colon separated WKT Geometries that will include any results that intersect any of them. |
exclusionGeometries | String | Semi-colon separated WKT Geometries that will exclude any results that intersect any of them. |
contextPoint | Well-known text | A WKT Point that is the starting point of a context query. |
returnGeoType | Alpha-numeric string |
The returning geometry type. There are 3 return types.
- 1 = geometry ( the whole geometry is returned)
- 2 = none ( no geometry is returned)
- 3 = centroid ( only centroid)
|
query | String | An SQL attribute criteria determining whether or not to use the database or a ShapeFileQuery. |
attributeLinks | Comma separated alpha-numeric string | A list of Links (see Resource Chaining) that correspond to each layer in layers. These Links will be used as attributes when applying styles. |
orderBy | Alpha-numeric string | The column name to sort by |
sortDir | Alphabetic string | Direction of sort. Must be either:- Asc = ascending (default)
- Desc = descending
|
maxCacheSize | Integer | The maximum number of records that will be used in cache. |
maxRecords | Integer | The maximum amount of resulting records. |
minRecords | Integer | The minimum amount of resulting records. |
geoBufferDist | Positive decimal | A distance to expand the geometry for a buffered search. |
geoBufferUnit | Alpha-numeric string | The units used for geoBufferDist. Must be one of the following: 1 = mile, 2 = kilometer, 3 = meter (default), 4 = feet |
cache | Boolean | If set to true, results are cached on the server. Caching only occurs for the base query, but not the linked query. |
useTransformer | String |
Specifies the URI of the XSLT transformer to apply to the output if the output is XML. If the output parameter is specified then this parameter will have no effect (since it only works on XML output).Supported URI protocols: |
viewInTime | String | Format (optional hh:mm:ss): YYYY-MM-DD hh:mm:ss. Gets a snapshot of the matching records at the specified point in time. |
includeHistory | Boolean | If set to true, allows creation of custom historical queries using DMP transaction fields. |
activeVersionId | Alpha-numeric string | Query will be performed on published records and records pending by the specified active version ID. |