Query (Map Service\Layer)

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

Note:

f=kmz would always return Z values.

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

Values: html | json | amf (when outStatistics is specified)

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

Description: 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 a short hand for a where clause of: where <displayField> like '%<text>%'. The text is case sensitive. This parameter is ignored if the where parameter is specified.

Example: text=Los

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:

• 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, etc. The default spatial relationship is intersects (esriSpatialRelIntersects).

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

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

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

Example: where=POP2000 > 350000

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

Description: The object IDs of this layer/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 1000 objectIds are specified.

Syntax: objectIds=<objectId1>, <objectId2>

Example: objectIds=37, 462

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.

Description: The list of fields to be included in the returned resultset. 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.

Example: outFields=AREANAME,ST,POP2000

Example (wildcard usage): outFields=*

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

Values: true | false

//This option was added at 10.0.

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

Description: 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=true and subsequently requesting feature sets for subsets of object IDs.

Values: false | true

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

Values: false | true

//This option was added at 10.1.

Description: One or more field names using the features/records that need to be ordered. Use ASC or DESC for ascending or desending order respectively.

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: 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, then map server would assign a field name to the returned statistic field. A valid field name can only contain alpha-numberic characters and an underscore.
• When outStatistics, the only other parameters that will be used are groupByFieldsForStatistics, orderByFields, text, time, and where.
• At version 10.1, specifying geometry, objectIds, or gdbVersion parameters would return an error.
• At version 10.1 SP1 support for geometry parameter was added.
• At version 10.2 support for gdbVersion parameter was added.

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: One or more field names using the values that need to be grouped for calculating the statistics.

Note:

groupByFieldsForStatistics is valid only when outStatistics parameter is used.

Syntax: groupByFieldsForStatistics=field1, field2

Example: groupByFieldsForStatistics=STATE_NAME, GENDER

//This option was added at 10.1.

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

//This option was added at 10.1.

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

//This option was added at 10.1.

Description: GeoDatabase version to query. This parameter applies only if hasVersionedData property of the service and isDataVersioned property of the layer(s) queried are true. If this is not specified, query will apply to published map's version.

Syntax: gdbVersion=<geodatabase version>

Example: gdbVersion=sde.USER1

//This option was added at 10.1 SP1.

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

Syntax: returnDistinctValues=<true | false>

Example: returnDistinctValues=true

//This option was added at 10.3.

Description: If true, returns true curves in output geometres, otherwise curves get converted to densified polylines or polygons.

Syntax: returnTrueCurves=<true | false>

Example: returnTrueCurves=true

//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 starts from the next record (i.e.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 maxRecordCountis 1000, you can get the next 100 records by setting resultOffset=1000 and resultRecordCount = 100, query results can 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, 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 upto 10 records