Query (Feature Service)

The response format. The default response format is html.

Values: html | json (default, when returnIdsOnly=false and returnCountOnly=false)

Values: html | json (when returnIdsOnly=true or returnCountOnly=true)

Description: Allows you to filter the features of individual layers in the query by specifying definition expressions (where clauses) for those layers. A definition expression for a layer that is published with the service will always be honored.

SQL 92 where clause syntax on the fields in the layer is supported for most data sources. Some data sources have restrictions on what is supported. Hosted feature services in ArcGIS Enterprise running on a spatiotemporal data source have restrictions on what is supported; they only support a subset of SQL 92. For example, spatiotemporal based feature services support the like operator but do not support the not like operator or field equivalency expressions like field1 = field2. Here is a list of supported SQL 92 with spatiotemporal based feature services:

( '<=' | '>=' | '<' | '>' | '=' | '!=' | '<>' | LIKE )

(AND | OR)

(IS | IS_NOT)

(IN | NOT_IN) ( '(' ( expr ( ',' expr )* )? ')' )

COLUMN_NAME BETWEEN LITERAL_VALUE AND LITERAL_VALUE

Simple syntax:

Syntax: layerId1:layerDef1;layerId2:layerDef2 where layerId1, layerId2 are the layer IDs returned by the feature service resource

Example: 0:POP2000 > 1000000;5:AREA > 100000

JSON syntax 1:

You can also use a JSON representation for Layer Definitions.

Syntax: { "<layerId1>" : "<layerDef1>" , "<layerId2>" : "<layerDef2>" } where layerId1, layerId2 are the layer IDs returned by the feature service resource

Example: {"0":"POP2000 > 1000000","5":"AREA > 100000"}

JSON syntax 2:

New at 10.1 SP1.

You can use this JSON representation of a layer definition to specify output fields.

Syntax: [{ "layerId" : <layerId1>,"where": "<where clause>", "outfields": "<field1>,<field2>"},{"layerId" : <layerId2>,"where": "<where clause>", "outfields": "<field1>,<field2>"}] where layerId1, layerId2 are the layer IDs returned by the feature service resource

Example: [{"layerId" : 0, "where" : "OBJECTID<100", "outFields" : "*"}, {"layerId" : 1, "where" : "OBJECTID<323", "outFields" : "OBJECTID,CREATOR"}]

The geometry to apply as the spatial filter. The structure of the geometry is the same as the structure of the JSON geometry objects returned by the ArcGIS REST API. In addition to the JSON structures, you can specify the geometry of envelopes and points with a simple comma-separated syntax.

Syntax:

• JSON structures: geometryType=<geometryType>&geometry={geometry}
• Envelope simple syntax: geometryType=esriGeometryEnvelope&geometry=<xmin>,<ymin>,<xmax>,<ymax>
• Point simple syntax: geometryType=esriGeometryPoint&geometry=<x>,<y>

Examples:

• geometryType=esriGeometryEnvelope&geometry={xmin: -104, ymin: 35.6, xmax: -94.32, ymax: 41}
• geometryType=esriGeometryEnvelope&geometry=-104,35.6,-94.32,41
• geometryType=esriGeometryPoint&geometry=-104,35.6

The type of geometry specified by the geometry parameter. The geometry type can be an envelope, a point, a line, or a polygon. The default geometry type is an envelope.

Values: esriGeometryPoint | esriGeometryMultipoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryEnvelope

The spatial reference of the input geometry.

The spatial reference can be specified as either a well-known ID or a spatial reference JSON object.

If inSR is not specified, the geometry is assumed to be in the spatial reference of the map.

The spatial relationship to be applied to the input geometry while performing the query. The supported spatial relationships include intersects, contains, envelope intersects, within, and so on. The default spatial relationship is intersects (esriSpatialRelIntersects).

Values: esriSpatialRelIntersects | esriSpatialRelContains | esriSpatialRelCrosses | esriSpatialRelEnvelopeIntersects | esriSpatialRelIndexIntersects | esriSpatialRelOverlaps | esriSpatialRelTouches | esriSpatialRelWithin

The time instant or the time extent to query.

Time instant

Syntax: time=<timeInstant>

Example: time=1199145600000 (1 Jan 2008 00:00:00 GMT)

Time extent

Syntax: time=<startTime>, <endTime>

Example: time=1199145600000, 1230768000000 (1 Jan 2008 00:00:00 GMT to 1 Jan 2009 00:00:00 GMT)

A null value specified for start time or end time will represent infinity for start or end time, respectively. Example: time=null, 1230768000000

Description: The spatial reference of the returned geometry.

The spatial reference can be specified as either a well-known ID or as a spatial reference json object.

If outSR is not specified, the geometry is returned in the spatial reference of the map.

Description: The geodatabase version to query. This parameter applies only if the hasVersionedData property of the service and the isDataVersioned property of the layer(s) queried are true.

If gdbVersion is not specified, the query will apply to the published map’s version.

Syntax: gdbVersion=<version>

Example: gdbVersion=SDE.DEFAULT

This option was added at 10.5 and works with ArcGIS Server services only.

Description: The historic moment to query. This parameter applies only if the supportsQueryWithHistoricMoment property of the layers being queried is set to true. This setting is provided in the layer resource.

If historicMoment is not specified, the query will apply to the current features.

Syntax: historicMoment=<Epoch time in milliseconds>

Example: historicMoment=1199145600000

This option was added at 10.1.

Description: If true, the result includes the geometry associated with each feature returned. The default is true.

Values: true | false

This option was added at 10.1.

Description: This option can be used to specify the maxAllowableOffset to be used for generalizing geometries returned by the query operation.

The maxAllowableOffset is in the units of the outSR. If outSR is not specified, then maxAllowableOffset is assumed to be in the unit of the spatial reference of the map.

Example: maxAllowableOffset=2

Description: If true, the response only includes an array of object IDs for each layer. Otherwise, the response is a feature set. The default is false.

While there is a limit to the number of features included in the feature set response, there is no limit to the number of object IDs returned in the ID array response. Clients can exploit this to get all the query conforming object IDs by specifying returnIdsOnly=true and subsequently requesting feature sets for subsets of object IDs.

Values: true | false

Description: If true, the response only includes the count (number of features/records) that would be returned by a query. Otherwise, the response is a feature set. The default is false.

Values: true | false

This option was added at 10.1.

Description: If true, Z values are included in the results if the features have Z values. Otherwise, Z values are not returned. The default is false.

This parameter only applies if returnGeometry is true, and at least one of the layer's hasZ property is true.

This option was added at 10.1.

Description: If true, M values are included in the results if the features have M values. Otherwise, M values are not returned. The default is false.

This parameter only applies if returnGeometry is true. and at least one of the layer's hasM property is true.

This option was added at 10.1.

Description: This option can be used to specify the number of decimal places in the response geometries returned by the query operation.

This applies to X and Y values only (not m or z-values).

Example: geometryPrecision=3

Description: This option dictates how the geometry of a multipatch feature will be returned.

Values: <xyFootprint | stripMaterials | embedMaterials | externalizeTextures>

This parameter only applies if the layers in the service have "geometryType": "esriGeometryMultipatch".

If multipatchOption = xyFootprint, the xy footprint of each multipatch geometry will be returned in the result.

If multipatchOption = stripMaterials, the multipatch geometry will be returned without materials (i.e. colors and textures).

If multipatchOption = embedMaterials, the multipatch geometry will be returned with materials embedded in it.

If multipatchOption = externalizeTextures, the multipatch geometry will be returned with materials, but the textures will be returned by reference.

Note:

If returnGeometry = false, specifying the multipatchOption is not required.

This option was added at 10.5.

Description: Optional parameter which is false by default.

When set to true, returns true curves in output geometries.

When set to false, curves are converted to densified polylines or polygons.

Values: true|false

Example: trueCurveClient=true

Description: The sqlFormat parameter can be either standard SQL92 standard or it can use the native SQL of the underlying datastore native. The default is none which means the sqlFormat depends on useStandardizedQuery parameter.

Values: none | standard | native

Note:

• The SQL format native is supported only when useStandardizedQuery=false.

The table summarizes the sqlFormat parameter and what you would expect from the query API.

Example: sqlFormat=standard