Query (Feature Service/Layer)

Description: The response format. The default response format is html.

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

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

Description: A where clause for the query filter.

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

Examples:

where=POP2000 > 350000

where=CITY_NAME = 'Barrington'

If you are working with ArcGIS Server 10.4 or a subsequent version, the dateFieldsTimezoneID property of the feature service identifies the time zone all dates are stored in. If you are querying a date type field and have dateFieldsTimezoneID set to a specific time zone, make sure your where clause issues the time in that specific time zone. For example, if you want to return all the records that match 1 pm on February 9th, 2015, Pacific Standard Time, your where clause would be:

where=pacific_time_date_field = DATE '2015-02-09 13:00:00'

Although you issue local time in your where clause, Query always returns date values in UTC. You can set the dateFieldsTimezoneID property in the ArcMap Service Editor, Parameters tab, when you publish the service. If you don't have dateFieldsTimezoneID set, be sure your where clause issues the time you are querying in UTC. The dateFieldsTimezoneID property does not apply to fields that were time enabled through the Layer Properties Time tab in ArcMap at the time of publishing.

Description: The object IDs of this layer or table to be queried.

Note:

There might be a drop in performance if the layer/table data source resides in an enterprise geodatabase and more than 1,000 objectIds are specified.

Syntax: objectIds=<objectId1>, <objectId2>

Example: objectIds=37, 462

Description: 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, for envelopes and points, you can specify the geometry with a simpler 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

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

Values: esriGeometryPoint | esriGeometryMultipoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryEnvelope

Description: The spatial reference of the input geometry.

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

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

Description: The spatial relationship to be applied on 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

Description: The spatial relate function that can be applied while performing the query operation. An example for this spatial relate function is "FFFTTT***".

For more information on this spatial relate function, see the documentation for the spatial relate function.

Note:

This parameter is not supported in the ArcGIS Online hosted service case.

Description: 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 buffer distance for the input geometries. The distance unit is specified by units. For example, if the distance is 100, the query geometry is a point, units is set to meters, and all points within 100 meters of the point are returned.

Syntax: distance=<distance>

Example: distance=100

The geodesic buffer is created based on the datum of the output spatial reference if it exists. If there is no output spatial reference, the input geometry spatial reference is used. Otherwise, the native layer spatial reference is used to generate the geometry buffer used in the query.

This parameter only applies if supportsQueryWithDistance is true.

Description: The unit for calculating the buffer distance. If unit is not specified, the unit is derived from the geometry spatial reference. If the geometry spatial reference is not specified, the unit is derived from the feature service data spatial reference.

This parameter only applies if supportsQueryWithDistance is true.

Values: esriSRUnit_Meter | esriSRUnit_StatuteMile | esriSRUnit_Foot | esriSRUnit_Kilometer | esriSRUnit_NauticalMile | esriSRUnit_USNauticalMile

Description: The list of fields to be included in the returned result set. This list is a comma delimited list of field names.

You can also specify the wildcard "*" as the value of this parameter. In this case, the query results include all the field values.

Example: outFields=AREANAME,ST,POP2000

Example (wildcard usage): outFields=*

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 outSR. If outSR is not specified, maxAllowableOffset is assumed to be in the unit of the spatial reference of the map.

Example: maxAllowableOffset=2

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: 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.

This option was added at 10.1.

Description: The geodatabase version to query. This parameter applies only if the isDataVersioned property of the layer is true. If this is not specified, the query will apply to the published map’s version.

Syntax: gdbVersion=<version>

Example: gdbVersion=SDE.DEFAULT

Description: If true, it returns distinct values based on the fields specified in outFields. This parameter applies only if the supportsAdvancedQueries property of the layer is true.

Values: <true | false>

Example: returnDistinctValues=true

Description: If true, the response only includes an array of object IDs. 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.

When objectIds are specified, setting this parameter to true is invalid.

Values: true | false

This option was added at 10.0 SP1.

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. This option supersedes the returnIdsOnly parameter. If returnCountOnly = true, the response will return both the count and the extent.

Values: true | false

This option was added at 10.3.

Note:

At 10.3, this option is only available for hosted feature services. At 10.3.1, this option is available for hosted and non-hosted feature services.

Description: If true, the response only includes the extent of the features that would be returned by the query. If returnCountOnly=true, the response will return both the count and the extent. The default is false. This parameter applies only if the supportsReturningQueryExtent property of the layer is true.

Values: true | false

This option was added at 10.1.

Description: One or more field names on which the features/records need to be ordered. Use ASC or DESC for ascending or descending, respectively, following every field to control the ordering.

Note:

• orderByFields is supported on only those layers/tables that indicate supportsAdvancedQueries is true.
• orderByFields defaults to ASC (ascending order) if <ORDER> is unspecified.

Syntax: orderByFields=field1 <ORDER>, field2 <ORDER>, field3 <ORDER>

Example: orderByFields=STATE_NAME ASC, RACE DESC, GENDER

This option was added at 10.1.

Description: One or more field names on which the values need to be grouped for calculating the statistics.

Note:

groupByFieldsForStatistics is valid only when the outStatistics parameter is used.

Syntax: groupByFieldsForStatistics=field1, field2

Example: groupByFieldsForStatistics=STATE_NAME, GENDER

This option was added at 10.1.

Description: The definitions for one or more field-based statistics to be calculated.

Note:

• outStatistics is supported on only those layers/tables that indicate supportsStatistics is true.
• If outStatisticFieldName is empty or missing, the map server assigns a field name to the returned statistic field. A valid field name can only contain alphanumeric characters and an underscore. If the outStatisticFieldName is a reserved keyword of the underlying DBMS, the operation can fail. Try specifying an alternative outStatisticFieldName.
• When using outStatistics, the only other parameters that can be used are groupByFieldsForStatistics, orderByFields, time, and where.

Values: An array of statistic definitions. A statistic definition specifies the type of statistic, the field on which it is to be calculated, and the resulting output field name.

Syntax:

[
  {
    "statisticType": "<count | sum | min | max | avg | stddev | var>",
    "onStatisticField": "Field1", 
    "outStatisticFieldName": "Out_Field_Name1"
  },
  {
    "statisticType": "<count | sum | min | max | avg | stddev | var>",
    "onStatisticField": "Field2",
    "outStatisticFieldName": "Out_Field_Name2"
  }  
]

Example:

[
  {
    "statisticType": "sum",
    "onStatisticField": "GENDER",
    "outStatisticFieldName": "PopulationByGender"
  },
  {
    "statisticType": "avg",
    "onStatisticField": "INCOME",
    "outStatisticFieldName": "AverageIncome"
  }
]

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 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 the layer's hasM property is true .

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

Values: <xyFootprint>

This parameter only applies if the layer's geometryType property is esriGeometryMultiPatch. If multipatchOption=xyFootprint, the xy footprint of each multipatch geometry will be returned in the result. Currently, the only supported value is xyFootprint . If returnGeometry=false, specifying the multipatchOption is not required.

This option was added at 10.3.

Description: This option can be used for fetching query results by skipping the specified number of records and starting from the next record (that is, resultOffset + 1th). The default is 0.

This parameter only applies if supportsPagination is true.

You can use this option to fetch records that are beyond maxRecordCount.

For example, if maxRecordCount is 1000, you can get the next 100 records by setting resultOffset=1000 and resultRecordCount = 100, so the query results will return the results in the range of 1001 to 1100.

This option was added at 10.3.

Description: This option can be used for fetching query results up to the resultRecordCount specified. When resultOffset is specified but this parameter is not, the map service defaults it to maxRecordCount. The maximum value for this parameter is the value of the layer's maxRecordCount property.

This parameter only applies if supportsPagination is true.

Example: resultRecordCount=10 to fetch up to 10 records

This option was added at 10.3.

This option was supported by hosted feature services in ArcGIS Enterprise at 10.6. By default it is set to false, but owners or administrators can use the updateDefinition operation on the layer to set it to supportsCoordinatesQuantization = true.

Description: Used to project the geometry onto a virtual grid, likely representing pixels on the screen.

Note:

• The quantization parameter only works with ArcGIS Online hosted services.
• This parameter only applies if supportsCoordinatesQuantization is true.

extent	An extent defining the quantization grid bounds. Its SpatialReference matches the input geometry spatial reference if one is specified for the query. Otherwise, the extent will be in the layer's spatial reference.
mode	Geometry coordinates are optimized for viewing and displaying of data. Value: view
originPosition	Integer coordinates will be returned relative to the origin position defined by this property value. Note: Default is upperLeft origin position. Values: upperLeft | lowerLeft
tolerance	The tolerance is the size of one pixel in the outSpatialReference units, this number is used to convert the coordinates to integers by building a grid with resolution matching the tolerance. Each coordinate is then snapped to one pixel on the grid. Consecutive coordinates snapped to the same pixel are removed to reduce the overall response size. The units of tolerance are defined by outSpatialReference. If the outSpatialReference is not specified, then tolerance is assumed to be in the unit of the spatial reference of the layer. If the tolerance is not specified, the maxAllowableOffset is used. Note: If the tolerance and maxAllowableOffset are not specified, a default 10,000 x 10,000 grid is used.

Example 1:

{"mode":"view","originPosition":"upperLeft","tolerance":1.0583354500042335,"extent":{"type":"extent","xmin":-18341377.47954369,"ymin":2979920.6113554947,"xmax":-7546517.393554582,"ymax":11203512.89298139,"spatialReference":{"wkid":102100,"latestWkid":3857}}}

Example 2:

http://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/USAShapeFoldersDec5/FeatureServer/2/query?f=html&where=1=1&returnGeometry=true&spatialRel=esriSpatialRelIntersects&outFields=*&outSR=102100&resultOffset=0&resultRecordCount=2000&quantizationParameters={"mode":"view","originPosition":"upperLeft","tolerance":1.0583354500042335,"extent":{"type":"extent","xmin":-19838806.04126036,"ymin":2146082.189218864,"xmax":-7455049.448307296,"ymax":11542768.51809405,"spatialReference":{"wkid":102100,"latestWkid":3857}}}

Example 3:

{"mode":"view","originPosition":"lowerLeft","tolerance":1.0583354500042335,"extent":{"type":"extent","xmin":-18341377.47954369,"ymin":2979920.6113554947,"xmax":-7546517.393554582,"ymax":11203512.89298139,"spatialReference":{"wkid":102100,"latestWkid":3857}}}

Example 4:

http://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/USAShapeFoldersDec5/FeatureServer/1/query?where=1=1&objectIds=&time=&geometry=&geometryType=esriGeometryEnvelope&inSR=&spatialRel=esriSpatialRelIntersects&distance=&units=esriSRUnit_Meter&outFields=*&returnGeometry=true&maxAllowableOffset=1.0583354500042335&geometryPrecision=&outSR=102100&returnIdsOnly=false&returnCountOnly=false&returnExtentOnly=false&orderByFields=&groupByFieldsForStatistics=&outStatistics=&resultOffset=0&resultRecordCount=2000&returnZ=false&returnM=false&quantizationParameters={"mode":"view","originPosition":"lowerLeft","tolerance":1.0583354500042335,"extent":{"type":"extent","xmin":-18341377.47954369,"ymin":2979920.6113554947,"xmax":-7546517.393554582,"ymax":11203512.89298139,"spatialReference":{"wkid":102100,"latestWkid":3857}}}&f=html&token=

Optional

Description: Used to return the geometry centroid associated with each feature returned. If true, the result includes the geometry centroid. The default is false.

Values: true | false

Note:

• This parameter is only supported on layer query and not service query.
• The returnCentroid parameter is currently only supported for polygon data.
• The returnCentroid parameter is ignored for count and object ID queries.
• The layer metadata returns supportReturningGeometryCentroid in the advancedQueryCapabilities metadata object.
• The absence of the supportReturningGeometryCentroid property means that the server does not support the returnCentriod parameter.
• Line and points data will return supportReturningGeometryCentriod = false.

Examples

Example 1: (When returnGeometry=true and returnCentroid=true)

http://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/USAStatesRiversCapitals/FeatureServer/2/query?where=1=1&objectIds=&uniqueIds=&time=&geometry=&geometryType=esriGeometryEnvelope&geohash=&inSR=&spatialRel=esriSpatialRelIntersects &distance=&units=esriSRUnit_Meter&outFields=*&returnGeometry=true&returnCentroid=true&maxAllowableOffset=&geometryPrecision=&outSR=& returnIdsOnly=false&returnUniqueIdsOnly=false&returnCountOnly=false&returnExtentOnly=false&returnDistinctValues=false&orderByFields=& groupByFieldsForStatistics=&outStatistics=&resultOffset=&resultRecordCount=&returnZ=false&returnM=false& quantizationParameters=&f=html&token=

Example 2: (When returnGeometry=false and returnCentroid=true)

http://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/USAStatesRiversCapitals/FeatureServer/2/query?where=1=1&objectIds=&uniqueIds=&time=&geometry=&geometryType=esriGeometryEnvelope&geohash=&inSR=&spatialRel=esriSpatialRelIntersects &distance=&units=esriSRUnit_Meter&outFields=*&returnGeometry=false&returnCentroid=true&maxAllowableOffset=&geometryPrecision=&outSR=& returnIdsOnly=false&returnUniqueIdsOnly=false&returnCountOnly=false&returnExtentOnly=false&returnDistinctValues=false&orderByFields=& groupByFieldsForStatistics=&outStatistics=&resultOffset=&resultRecordCount=&returnZ=false&returnM=false& quantizationParameters=&f=html& token=

Optional

Description: The resultType parameter can be used to control the number of features returned by the query operation.

Values: none | standard | tile

Note:

• Support for the resultType parameter is advertised on the layer metadata. For example {"supportQueryWithResultType": true/false}.
• The maxTileRecordCount and maxStandardRecordCount are server managed (determined by the server). The feature service assigns the max record count relevant to the resultType query parameter.
  • If no resultType query parameter is used then the default maxRecordCount is always used. This can be the default server assigned maxRecordCount (1000, 2000) or an overwritten value provided by the service owner/admin.
  • The resultType=tile is used when the client is using virtual tiling scheme when querying features. Virtual tiling scheme works similar to tiles in a tiled map service layer.
  • The resultType=standard is used with a non-tiled query where the client will send only one query for the full extent.
• Server advertises max record counts with the layer metadata. For example for points data we return the following max record count:
  • Ex: {'maxRecordCount" : 2000, "tileMaxRecordCount" : 8000, "standardMaxRecordCount" : 32000}.
• The values of the max record counts might vary based on the type of the data (polygon, point, polyline, table).
• Pagination queries also support resultType query parameter.
  • If the resultType is specified and the resultRecordCount is not specified with the resultOffset, the server will determine the maxRecordCount relevant to the resultType query parameter.
  • The client can supply the resultRecordCount parameter in the request. This cannot be greater than the standard/tile maxRecordCount value if resultType is used.
• The layer metadata includes maxRecordCountFactor that can be configured from the admin API. The server maxRecordCountFactor for the tileMaxRecordCount and standardMaxRecordCount is used as a multiplier for the server base value.
  • All maxRecordCount values are adjusted with the maxRecordCountFactor.

Examples

Example 1: (When resultType=none)

The default maxRecordCount is always used. This can be the default server assigned ("maxRecordCount" : 2000) or an overwritten value by the service owner/admin.

http://services.myserver.com/OrgID/ArcGIS/rest/services/USAStatesRiversCapitals/FeatureServer/2/query?where=1=1&objectIds=&time=&geometry=&geometryType=esriGeometryEnvelope&inSR=&spatialRel=esriSpatialRelIntersects&resultType=none&distance= &units=esriSRUnit_Meter&outFields=*&returnGeometry=true&multipatchOption=&maxAllowableOffset=&geometryPrecision=&outSR=&returnIdsOnly=false &returnCountOnly=false&returnExtentOnly=false&returnDistinctValues=false&orderByFields=&groupByFieldsForStatistics=&outStatistics= &resultOffset=&resultRecordCount=&returnZ=false&returnM=false&quantizationParameters=&sqlFormat=none&f=html&token=

Example 2: (When resultType=standard)

The standardMaxRecordCount is always used. Ex: ("standardMaxRecordCount" : 32000) for point and table layer.

http://services.myserver.com/OrgID/ArcGIS/rest/services/USAStatesRiversCapitals/FeatureServer/2/query?where=1=1&objectIds=&time=&geometry=&geometryType=esriGeometryEnvelope&inSR=&spatialRel=esriSpatialRelIntersects&resultType=standard&distance= &units=esriSRUnit_Meter&outFields=*&returnGeometry=true&multipatchOption=&maxAllowableOffset=&geometryPrecision=&outSR=&returnIdsOnly=false &returnCountOnly=false&returnExtentOnly=false&returnDistinctValues=false&orderByFields=&groupByFieldsForStatistics=&outStatistics= &resultOffset=&resultRecordCount=&returnZ=false&returnM=false&quantizationParameters=&sqlFormat=none&f=html&token=

Example 3: (When resultType=tile)

The tileMaxRecordCount is always used. Ex: ('tileMaxRecordCount" : 8000) for point layer.

http://services.myserver.com/OrgID/ArcGIS/rest/services/USAStatesRiversCapitals/FeatureServer/2/query?where=1=1&objectIds=&time=&geometry=&geometryType=esriGeometryEnvelope&inSR=&spatialRel=esriSpatialRelIntersects&resultType=tile&distance= &units=esriSRUnit_Meter&outFields=*&returnGeometry=true&multipatchOption=&maxAllowableOffset=&geometryPrecision=&outSR=&returnIdsOnly=false &returnCountOnly=false&returnExtentOnly=false&returnDistinctValues=false&orderByFields=&groupByFieldsForStatistics=&outStatistics= &resultOffset=&resultRecordCount=&returnZ=false&returnM=false&quantizationParameters=&sqlFormat=none&f=html&token=

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 layer is archiving enabled and the supportsQueryWithHistoricMoment property is set to true. This property 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.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 when useStandardizedQuery=false.

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

Example: sqlFormat=standard

This option was added at 10.6 for hosted feature services.

Description: Optional parameter which is true by default.

When set to true, features are returned even when the results include "exceededTransferLimit": true.

When set to false and querying with resultType = tile features are not returned when the results include "exceededTransferLimit": true. This allows a client to find the resolution in which the transfer limit is no longer exceeded without making multiple calls.

Values: true|false

Example: returnExceededLimitFeatures=false