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 | geojson | kmz | amf (default, when returnIdsOnly=false and returnCountOnly=false)

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

Values: html | json | geojson (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 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.

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, and so on. 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 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 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 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.

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.

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. 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 result set includes the geometry associated with each result. The default is true.

Values: true | false

Note:

This parameter cannot be used with returnDistinctValues.

//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.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 nonhosted 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 or expressions that the features/records need to be ordered by. Use ASC or DESC for ascending or descending order, respectively.

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 is supported on only those layers/tables that indicate supportsAdvancedQueries is true.
• orderByFields defaults to ASC (ascending order) if <ORDER> is unspecified.
• When used with outStatistics, only field names specified in outStatisticFieldName or groupByFieldsForStatistics are allowed.

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

Example: orderByFields=STATE_NAME ASC, RACE DESC, GENDER

Example: orderByFields=POPULATION / SHAPE_AREA

//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 would assign a field name to the returned statistic field. A valid field name can only contain alphanumeric 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 the geometry parameter was added.
• At version 10.2, support for the 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:

• 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.
• groupByFieldsForStatistics is valid only when the outStatistics parameter is used.

Syntax: groupByFieldsForStatistics=expression1, expression2

Example: groupByFieldsForStatistics=STATE_NAME, GENDER

Example: groupByFieldsForStatistics=extract(month from incident_date) to group by month when StandardizedQueries is enabled.

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

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 the supportsAdvancedQueries property of the layer is true.

Syntax: returnDistinctValues=<true | false>

Example: returnDistinctValues=true

Note:

This parameter cannot be used when returnGeometry is true.

//This option was added at 10.3.

Description: If true, returns true curves in output geometries; otherwise, curves are 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 (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.

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

Description: 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, you need to think about which datum transformation best applicable to project the layer (not the map service) to the outSR. 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 Geographic transformations.

Syntax: datumTransformation=wkid1.

Examples: datumTransformation=1623 to apply a transformation.

Syntax: datumTransformation={<dt1>}.

Examples: datumTransformation={"geoTransforms":[{"wkid":108889,"transformForward":true},{"wkid":1622,"transformForward":false}]} to apply a composite transformation.

For more information on datum transformation, please see transformation parameter in Project operation.

//This option was added at 10.5

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

Syntax:

[
    {
      "name" : "<rangeName1>",           //range id
      "value"   : <value> |               //single value or 
                  [ <value1>, <value2> ] //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> ]
    }
  ]
&

Example:

[
    {
      "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.5

Description: Allows you to filter the features layers by specifying value(s) to an array of pre-authored parameterized filters for those layers. When value is not specified for any parameter in a request, the default value, that is assigned during authoring time, gets 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.

Syntax:

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

Example:

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