Query (Map Service/Layer)

A literal search text. If the layer has a display field associated with it, the server searches for this text in this field. This parameter is shorthand for a WHERE clause of where <displayField> like '%<text>%'. The text is case sensitive. This parameter is ignored if the WHERE parameter is specified.

text=Los

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 for Envelope geometryType
geometry={xmin: -104, ymin: 35.6, xmax: -94.32, ymax: 41}

//Syntax for Envelope geometryType
geometry=-104,35.6,-94.32,41

//Syntax for Point geometryType
geometry=-104,35.6

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

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.

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 | esriSpatialRelRelation

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, refer to the documentation for the spatial relate function.

A WHERE clause for the query filter. Any legal SQL WHERE clause operating on the fields in the layer is allowed.

where=POP2000 > 350000

//When standardized queries are enabled
where = CHAR_LENGTH(cntry_name) > 18

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.

objectIds=<objectId1>, <objectId2>

objectIds=37, 462

The time instant or the time extent to query. A null value specified for start time or end time will represent infinity for start or end time, respectively.

//Time instant
time=<timeInstant>

//Time extent
time=<startTime>, <endTime>

//Time instant for 1 Jan 2008 00:00:00 GMT
time=1199145600000

//Time extent for 1 Jan 2008 00:00:00 GMT to 1 Jan 2009 00:00:00 GMT
time=1199145600000, 1230768000000

This parameter only applies if supportsQueryWithDistance is true.

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 esriSRUnit_Meter, and all points within 100 meters of the point are returned.

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.

distance=<distance>

distance=100

This parameter only applies if supportsQueryWithDistance is true. The unit for calculating the buffer distance.

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

The list of fields to be included in the returned result set. This list is a comma-delimited list of field names. If you specify the shape field in the list of return fields, it is ignored. To request geometry, set returnGeometry to true. You can also specify the wildcard "*" as the value of this parameter. In this case, the query results include all the field values.

outFields=AREANAME,ST,POP2000

//Wildcard usage
outFields=*

If true, the result set includes the geometry associated with each result. The default is true.

Note:

This parameter cannot be used with returnDistinctValues.

Values: true | false

This option was added at 10.0. 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, maxAllowableOffset is assumed to be in the unit of the spatial reference of the map.

maxAllowableOffset=2

This option was added at 10.1. 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).

geometryPrecision=3

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.

When using outSR with pbf, the pbf format will use coordinate quantization for layer queries. When an output spatial reference is not provided for a query operation, the Map Service derives coordinate quantization parameters from the layer's spatial reference. If the precision in the layer's spatial references is inadequate for the client application's use, it should pass in a spatial reference with suitable precision as the output spatial reference. If the layer's source spatial reference has the desired precision and it is suitable for the client's use, the client can use the source layer's spatial reference as the output spatial reference.

If true, the response only includes an array of object IDs. Otherwise the response is a feature set. The default is false. Note that while there is a limit on the number of features included in the feature set response, there is no limit on 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 is true and subsequently requesting feature sets for subsets of object IDs.

Values: true | false

This option was added at 10.0 SP1. 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.

Values: true | false

This option was added at 10.4. If true, the response only includes the extent of the features that would be returned by the query. If returnCountOnly is 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. This parameter specifies one or more field names or expressions that the features or records need to be ordered by. Use ASC or DESC for ascending or descending order, respectively. This parameter is supported on only those layers and tables that have the supportsAdvancedQueries property set to true. When used with outStatistics, only field names specified in outStatisticFieldName or groupByFieldsForStatistics are allowed. orderByFields defaults to ASC (ascending order) if <ORDER> is unspecified.

Note:

At 10.4, expressions are allowed in addition to field name. When StandardizedQueries is enabled, only expressions that conform to the specifications are allowed. When StandardizedQueries is disabled, you can pass in any expression that the underlying database allows.

orderByFields=expression1 <ORDER>, expression2 <ORDER>, expression3
<ORDER>

orderByFields=STATE_NAME ASC, RACE DESC, GENDER

orderByFields=POPULATION / SHAPE_AREA

This option was added at 10.1. This parameter provides definitions for one or more field-based statistics to be calculated. This parameter is only supported on layers and tables that have the supportsStatistics property set to true. When using outStatistics, the following parameters are supported:

• groupByFieldsForStatisticstext
• orderByFields
• text
• time
• where
• geometry (Support added at 10.1 SP1)
• gdbVersion (Support added at 10.2)
• percentile (Support added at 10.8.1)
• statisticType (Support added at 10.8.1)
  Note:

  For more information on percentile statistic types, see the Percentile statistic type section below.

Note:

If outStatisticFieldName is empty or missing, the map server will assign a field name to the returned statistic field. A valid field name can only contain alphanumeric characters and an underscore.

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.

[
  {
    "statisticType": "<count | sum | min | max | avg | stddev | var | percentile_cont | percentile_desc>",
    "onStatisticField": "Field1",
    "statisticParameters": {   //only needed for percentile statistic type
      "value": value
    }, 
    "outStatisticFieldName": "Out_Field_Name1"
  },
  {
    "statisticType": "<count | sum | min | max | avg | stddev | var | percentile_cont | percentile_desc>",
    "onStatisticField": "Field2",
    "statisticParameters": {   //only needed for percentile statistic type
      "value": value
    }, 
    "outStatisticFieldName": "Out_Field_Name2"
  }  
]

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

Added at 10.1. This parameter specifies one or more field names using the values that need to be grouped for calculating the statistics. At 10.4, expressions are allowed in addition to field name. When StandardizedQueries is enabled, only expressions that conform to the specifications are allowed. When StandardizedQueries is disabled, you can pass in any expression that the underlying database allows.

Note:

This parameter is only valid when the outStatistics parameter is used.

groupByFieldsForStatistics=expression1, expression2

groupByFieldsForStatistics=STATE_NAME, GENDER

//Group by month when StandardizedQueries is enabled
groupByFieldsForStatistics=extract(month from incident_date)

Added at 10.1. If true, the z-values will be included in the results if the features have z-values. Otherwise z-values are not returned. The default is false.

Note:

This parameter only applies if returnGeometry is true.

Added at 10.1. If true, m-values will be included in the results if the features have m-values. Otherwise, m-values are not returned. The default is false.

Note:

This parameter only applies if returnGeometry is true.

Added at 10.1. GeoDatabase version to query. This parameter applies only if the hasVersionedData property of the service and the isDataVersioned property of the layers queried are true. If this is not specified, the query will apply to the published map's version.

gdbVersion=<geodatabase version>

gdbVersion=sde.USER1

Added at 10.1 SP1. If true, returns distinct values based on the fields specified in outFields. This parameter applies only if the supportsAdvancedQueries property of the layer is true.

Note:

This parameter cannot be used when returnGeometry is true.

returnDistinctValues=<true | false>

returnDistinctValues=true

Added at 10.3. If true, returns true curves in output geometries; otherwise, curves are converted to densified polylines or polygons.

Values: true | false

Added at 10.3. This option can be used for fetching query results by skipping the specified number of records and starts from the next record (for example, 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 1,000, you can get the next 100 records by setting resultOffset=1000 and resultRecordCount = 100; query results can return the results in the range of 1,001 to 1,100.

Added at 10.3. 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.

//fetches up to 10 records
resultRecordCount=10

The sqlFormat parameter can be either standard SQL-92 standard or it can use the native SQL of the underlying data store native. The default is none, which means the sqlFormat depends on the useStandardizedQuery parameter. The native format is supported when useStandardizedQuery is false. For more information on formatting, see the SQL format section below.

Note:

You must check for the supportsSqlFormat layer property before using this parameter.

Values: none | standard | native

This option was added at 10.5. Use this parameter to apply a datum transformation while projecting geometries in the results when outSR is different than the layer's spatial reference.

Note:

While specifying transformation, consider which datum transformation is the most applicable to project the layer (not the map service) to the outSR. The sourceSpatialReference property in the layer resource reports which spatial reference features are stored in the source dataset.

For a list of valid datum transformation ID values and well-known text strings, see Using spatial references. For more information on datum transformations, see the transformation parameter in the Project operation.

//Syntax to apply a transformation
datumTransformation=wkid1

//Syntax to apply a composite transformation
datumTransformation={<dt1>}

//Apply a transformation
datumTransformation=1623

//Apply a composite transformation
datumTransformation={"geoTransforms":[{"wkid":108889,"transformForward":true},{"wkid":1622,"transformForward":false}]}

This option was added at 10.5. It allows you to filter features from the layer that are within the specified range instant or extent.

Note:

Check rangeInfos at the layer resources for the available ranges.

[
  {
    "name": "<rangeName1>",  //range id
    "value": <value> | [ <value1>, <value2> ]  //single value or a value-range
        // null is allowed in value-range case -- that means infinity
       // e.g. [null, 1500] means all features with values <= 1500
      // [1000, null] means all features with values >= 1000
    },
    {
      "name": "<rangeName2>",
      "value": <value> |  [ <value3>, <value4> ]
    }
  }
]

[
  {
    "name": "salinity",
    "value": 5  //a range instant (or single) value passed
  },
  {
    "name": "elevation",
    "value": [1000, 1500] //a range extent is passed
  }
]

This option was added at 10.6.1. This is used to project the geometry onto a virtual grid, likely representing pixels on the screen. For JSON property descriptions and examples, see the Quantization parameters JSON properties section below.

Note:

This parameter only applies if supportsCoordinatesQuantization is true.

This option was added at 10.5. It allows you to filter the features layers by specifying values to an array of preauthored parameterized filters for those layers. When a value is not specified for any parameter in a request, the default value, which is assigned during authoring time, is used instead.

When a parameterInfo allows multiple values, you must pass them in an array.

Note:

Check parameterInfos at the layer resources for the available parameterized filters, their default values, and expected data type.

{
  "<parameterName1>": <value>, //when the multipleValues=false in the parameterInfo
  "<parameterName2>": [<value1> | <value2>]  //when the multipleValues=true in the parameterInfo
}

{
  "floor": 10,
  "incidentDate": 1475877014000 //date time value needs to be passed in as epoch value
}

This option was added at 10.6.1. This specifies 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.

historicMoment=<Epoch time in milliseconds>

historicMoment=1199145600000

(Binning LOD Type )

Added at 10.9. This specifies the lodType. Check layer resources to find the lodType supported by a layer.

Values: esriGeometryPoint | esriGeometryMultipoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryEnvelope

(Binning LOD Level)

Added at 10.9. This specifies the lod level. Check layer resources for available levels.

(Binning LOD Spatial Reference)

Added at 10.9. This specifies the lod level. Check layer resources for available LOD spatial reference.

The response format. The default response format is html. Protocol buffer (pbf) format is only supported when the supportedQueryFormat property on the layer includes pbf.

Note:

kmz will always return z-values.

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

Values: html | json (when outStatistics is specified)

Values: html | json | geojson | pbf (when either returnIdsOnly=true or returnCountOnly=true is specified)

Note:

The output format f=geojson is not supported if returnM is true.