Query (Map Service/Layer)

Description

Note that all parameters related to geometry will be ignored when querying tables.

The result of this operation is a feature set. This feature set contains feature objects including the values for the fields requested by the user. For layers, if you request geometry information, the geometry of each feature is also returned in the feature set. For tables, the feature set does not include geometries.

New in 11.2

• esriFieldTypeObjectID supports 64-bit integer values.

• When esriFieldTypeDate 's precision is 1, query response includes milliseconds. When precision value is 0, last 3 digits of epoch values are always 0s.

• Support for four new field types are added. They are:esriFieldTypeBigInt ,esriFieldTypeTimestampOffset ,esriFieldTypeDateOnly , esriFieldTypeTimeOnly . Please see Date-time queries section below.

  • Values returned for esriFieldTypeTimestampOffset field types are string literals conforming to ISO 8601 standard i.e. YYYY-MM-DDThh:mm:ss.sss+/-HH:MM . These values represent absolute time comprised of wall-clock time and an offset from UTC.

    • This field type allows storing date/time values from multiple time zones in a single field.

  • Values returned for esriFieldTypeDateOnly field types are string literals conforming to ISO 8601 standard and contains only date parts without any time parts i.e. YYYY-MM-DD

  • Values returned for esriFieldTypeTimeOnly field types are string literals conforming to ISO 8601 standard and contains only time parts without any date parts i.e. hh:mm:ss . There is no milliseconds support in this field type.

• A special keyword current_user is supported in the where clause . This is helpful when you want to view records/features that belongs to or edited/inserted by the currently logged in user. This keyword is supported when "supportsCurrentUserQueries": true in the layers "advancedQueryCapabilities" property. Note that this enhancement requires the server to have standardizedQueries enabled

New in 10.9

• The Query operation is enhanced to return spatially aggregated results in regularly shaped polygon (such as hexagon, square, and so on) tessellation from point features.

  • You need to check the value for SupportsLOD property in the layer resources before making requests with lod , lodType or lodSR optionally combined with outStatistics and other query parameters.

• Percentile in an outStatistics query is supported for layers and tables in a file geodatabase.

10.8.1

The layer query operation supports percentile as a statisticType when using outStatistics for map services published from ArcGIS Pro that reference enterprise geodatabase data. Layers that support percentiles include the supportsPercentileStatistics property as true , found in the advancedQueryCapabilities layer object.

New in 10.7.1

• Map Services now support the protocol buffer (pbf ) format. This format is supported on map services from ArcGIS Pro. The supportedQueryFormats layer property will list pbf if it is available on the layer.

New in 10.7

• Support for amf output format was removed.

New in 10.6.1

• Supports the following new parameters.

  • historicMoment to query from a given moment in an archive enabled layer.

• Supports returning 'number of unique values', instead of a list of unique value, off a field when values for both returnCountOnly and returnDistinctValues are true.

• Map services now support quantizationParameters .

New in 10.5

• Supports the following new parameters.

  • datumTransformations to provide a desired datum transformation to be applied while features get projected.
  • rangeValues to set values to ranges.
  • parameterValues to set value to parameterized filters.

• Supports passing in SQL expressions in outStatistics . Check supportsSqlExpression on resources to find out whether the layer/table allows SQL expressions.

New at 10.4

• Supports GeoJSON as a response format.
• Supports passing in expressions in orderByFields and groupByFieldsForStatistics . When useStandardizedQueries is true , you can pass in expressions that conform to StandardizedQueries specifications. Otherwise, any expressions that are supported by the underlying database can be passed in.

New at 10.3.1

• The exceededTransferLimit property is now included in the JSON response when paging through a query result with the resultOffset and resultRecordCount parameters. When exceededTransferLimit is true , it indicates there are more query results and you can continue to page through the results. When exceededTransferLimit is false , or this property is absent in a query result, it indicates that you have reached the end of the query results.

New at 10.3

• Supports pagination in a query layer. UseresultOffset and resultRecordCount parameters to page through a query result.
• Note that when you pass in one of these two parameters and orderByFields is left empty, the map service uses the object-id field to sort the result. For a query layer with a pseudocolumn as the object-id field (for example, FID), you must provide orderByFields or else the query will fail.
• query now supports true curves in an input geometry parameter.
• query now returns true curves in output geometries when the returnTrueCurves parameter is set to true.
• Learn more about JSON Curve Objects in Geometry Objects.

New at 10.2

• The where parameter value must conform to the standardized queries, if the layer/table resource advertises useStandardizedQueries is true. Learn more about standardized queries.
• outStatistics now supports the gdbVersion parameter.

New at 10.1 SP1

• Support for a new parameter named returnDistinctValues that accepts a Boolean value was added. When true, the query result would contain distinct values based on the fields specified in the outFields parameter.
• outStatistics now supports the geometry parameter.

New at 10.1

• Support for orderByFields , outStatistics , and groupByFieldsForStatistics was added for both layers and tables.
• Support for returnZ and returnM was added for layers. Default value for returnZ and returnM is false.
• When output format f is kmz, the result would always contain a z-value irrespective of the returnZ property value. If the feature geometry does not support z, a default value of 0 would be returned for z.
• Support for the gdbVersion parameter was added. Use this parameter to specify the geodatabase version to query.
• The geometryPrecision parameter was introduced. This option can be used to specify the number of decimal places in the response geometries returned by the query operation.
• JSON response contains an optional property exceededTransferLimit . This property will be true only if the number of records exceeds the maximum number configured by the server administrator.

New at 10.0 SP1

• At 10.0 SP1, support for returning the count (number of features/records) that would be returned by a query was added for both layers and tables.

New at 10.0

• Support for querying layers and tables based on time was added at 10.0. For time-aware layers, users can use the time parameter to specify the time instant or the time extent to query.

• A new returnIdsOnly parameter was introduced. If set to false (default), the response will be a feature set. If true , the response will be an array of object IDs.

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

• Support for query based on objectIds was added.

• Support for f=amf was added.

• Support for generalizing geometries returned by the query operation was added.

• The query operation returns an additional fields array (JSON and AMF only) that contains array of field information for returned values. This array contains only fields specified in the outFields parameter. See Layer/Table for details on fields.

• The fieldAliases member is deprecated.

You can provide arguments to the query operation as query parameters defined in the parameters table below.

Request parameters

1
text=Los

1
2
3
4
5
6
7
8
//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

1
2
3
4
where=POP2000 > 350000

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

1
objectIds=<objectId1>, <objectId2>

1
objectIds=37, 462

1
2
3
4
5
//Time instant
time=<timeInstant>

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

1
2
3
4
5
//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

1
distance=<distance>

1
distance=100

1
2
3
4
outFields=AREANAME,ST,POP2000

//Wildcard usage
outFields=*

1
maxAllowableOffset=2

1
geometryPrecision=3

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

1
2
3
orderByFields=STATE_NAME ASC, RACE DESC, GENDER

orderByFields=POPULATION / SHAPE_AREA

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
[
  {
    "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"
  }
]

1
2
3
4
5
6
7
8
9
10
11
12
[
  {
    "statisticType": "sum",
    "onStatisticField": "GENDER",
    "outStatisticFieldName": "PopulationByGender"
  },
  {
    "statisticType": "avg",
    "onStatisticField": "INCOME",
    "outStatisticFieldName": "AverageIncome"
  }
]

1
groupByFieldsForStatistics=expression1, expression2

1
2
3
4
groupByFieldsForStatistics=STATE_NAME, GENDER

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

1
gdbVersion=<geodatabase version>

1
gdbVersion=sde.USER1

1
returnDistinctValues=<true | false>

1
returnDistinctValues=true

1
2
//fetches up to 10 records
resultRecordCount=10

1
2
3
4
5
6
//Syntax to apply a transformation
datumTransformation=wkid1

//Syntax to apply a composite transformation
datumTransformation={"wkid": <wkid1>}
datumTransformation={"wkt": "<wkt1>"}

1
2
3
4
5
6
7
8
//Apply a transformation
datumTransformation=1623

datumTransformations={"wkt": "GEOGTRAN[\"S_JTSK_To_WGS_1984_1\", GEOGCS[\"GCS_S_JTSK\", DATUM[\"D_S_JTSK\", SPHEROID[\"Bessel_1841\", 6377397.155, 299.1528128]], PRIMEM[\"Greenwich\", 0.0], UNIT[\"Degree\", 0.0174532925199433]], GEOGCS[\"GCS_WGS_1984\", DATUM[\"D_WGS_1984\", SPHEROID[\"WGS_1984\", 6378137.0, 298.257223563]], PRIMEM[\"Greenwich\", 0.0], UNIT[\"Degree\", 0.0174532925199433]], METHOD[\"Position_Vector\"], PARAMETER[\"X_Axis_Translation\", 570.8], PARAMETER[\"Y_Axis_Translation\", 85.7], PARAMETER[\"Z_Axis_Translation\", 462.8], PARAMETER[\"X_Axis_Rotation\", 4.998], PARAMETER[\"Y_Axis_Rotation\", 1.587], PARAMETER[\"Z_Axis_Rotation\", 5.261], PARAMETER[\"Scale_Difference\", 3.56], OPERATIONACCURACY[1.0]]"}


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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
[
  {
    "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> ]
    }
  }
]

1
2
3
4
5
6
7
8
9
10
[
  {
    "name": "salinity",
    "value": 5  //a range instant (or single) value passed
  },
  {
    "name": "elevation",
    "value": [1000, 1500] //a range extent is passed
  }
]

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

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

1
historicMoment=<Epoch time in milliseconds>

1
historicMoment=1199145600000

Quantization parameters JSON properties

The following table outlines the JSON properties for the quantizationParameters parameter:

Example one

The following example demonstrates possible values for the quantizationParameters parameter:

1
quantizationParameters={"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}}}

The following is a sample URL that reflects the JSON object above:

1
https://machine.domain.com/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 two

The following example demonstrates possible values for the quantizationParameters parameter:

1
{"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}}}

The following is a sample URL that reflects the JSON object above:

1
https://machine.domain.com/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=

Date-time queries

Time zone properties

In general, the dateFieldsTimeReference property of the feature service layer identifies the time zone that all dates are stored in. The exception cases involve editor tracking date fields and time aware layer time zones.

When you are working with your data, you need to consider the time zone of the fields that you are working with. If you are querying a date type field and dateFieldsTimeReference is 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:00 p.m. on February 9, 2015, Pacific standard time, your WHERE clause would be as follows:

Querying records in PST

1
where=pacific_time_date_field = TIMESTAMP '2015-02-09 13:00:00'

However, it is possible to have up to three different time zones defined on your service. If your query includes dates from the editor tracking fields or the time aware fields, you need to make sure you submit the query in their respective time zones. The time zones for these fields can be found in the properties mentioned above. If the dateFieldsTimeReference is null the data is assumed to be in UTC, and if it is Unknown the time zone is assumed to be undefined. The example below demonstrates how to query three date fields that have three different times zones. When querying fields in different time zones, you need to make sure the time you use corresponds with the time zone of the date field. There is a date field in PST, one in EST, and the editor tracking field created_date in UTC:

Querying records in three different time zones

1
where=(DateTime_PST=TIMESTAMP '2012-01-01 15:20:00' AND (DateTime_EST=TIMESTAMP '2012-01-01 18:20:00' AND created_date=TIMESTAMP '2012-01-01 22:20:00')

Although you issue local time in your WHERE clause, the query operation always returns date values in UTC. You can set the date fields time zone, which shows up in the dateFieldsTimeReference property of the feature service layer either during publishing or in the ArcGIS Server Manager after publishing. In the Server Manager, navigate to service you wish to edit and click on the Parameters tab to update the time zone information. If the dateFieldsTimeReference property is not set, it will show up as null and the data will be assumed to be in UTC. In this case make sure you issue your WHERE clause in UTC.

As of ArcGIS Pro 3.1 and ArcGIS Enterprise 10.9, there is a new option when defining the time zone during publishing. If you don't want to define a time zone at all (not even UTC), you can set it to Unknown. Using the Unknown time zone makes it so that there is no translation done when the query operation submits and returns date values, they are stored and returned as is. This is particularly useful if you have data which spans multiple time zones.

Date, time and time zone offset format

When StandardizedQueries is enabled, use following SQL functions and syntaxes while querying against a date-time field. When StandardizedQueries is turned off, you must consult to the underlying database's help references to find the correct syntax.

Note: At 11.2 release, both map and feature services added support for 3 new field types in addition to the existing esriFieldTypeDate .

1
<timestampoffset_field> = timestamp 'yyyy-mm-dd HH24:mm:ss.fff -TZH:TZM'

1
flight_arrival = timestamp '2003-01-25 14:35:00 -08:00'

1
<date_field> = timestamp 'yyyy-mm-dd HH24:mm:ss'

1
incident_datetime = timestamp '2003-01-25 14:35:00'

1
<dateonly_field> = date 'yyyy-mm-dd'

1
birth_date = date '1990-01-25 14:35:00 -08:00'

1
<timeonly_field> = time 'HH24:mm:ss'

1
store_close_time = time '21:00:00'

Interval queries

the INTERVAL syntax can be used in place of the date-time queries and is standardized across all map and feature services. The INTERVAL syntax can be used to specify either the current date or timestamp in the query when StandardizedQueries is enabled:

1
2
3
4
5
//Date
<DateField> >= CURRENT_DATE -+ INTERVAL '<IntervalValue>' <TimeStampFormat>

//Timestamp
<DateField> >= CURRENT_TIMESTAMP -+ INTERVAL '<IntervalValue>' <TimeStampFormat>

For the syntax demonstrated above, you can interchange the CURRENT_DATE and CURRENT_TIMESTAMP values. Both can be used with + or - of INTERVAL values.

The examples below outline the different ways in which the INTERVAL syntax can be modified for the purposes of your query:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
//'DD' Day
<DateField> >= CURRENT_TIMESTAMP -+ INTERVAL 'DD' DAY

//'HH' Hour
<DateField> >= CURRENT_TIMESTAMP -+ INTERVAL 'HH' HOUR

//'MI' Minute
<DateField> >= CURRENT_TIMESTAMP -+ INTERVAL 'MI' MINUTE

//'SS(.FFF)' Second
<DateField> >= CURRENT_TIMESTAMP -+ INTERVAL 'SS(.FFF)' SECOND

//'DD HH' DAY TO HOUR
<DateField> >= CURRENT_TIMESTAMP -+ INTERVAL 'DD HH' DAY TO HOUR

//'DD HH:MI' DAY TO MINUTE
<DateField> >= CURRENT_TIMESTAMP -+ INTERVAL 'DD HH:MI' DTY TO MINUTE

//'DD HH:MI:SS(.FFF)' DAY TO SECOND
<DateField> >= CURRENT_TIMESTAMP -+ INTERVAL 'DD HH:MI:SS(.FFF)' DAY TO SECOND

//'HH:MI' HOUR TO MINUTE
<DateField> >= CURRENT_TIMESTAMP -+ INTERVAL 'HH:MI' HOUR TO MINUTE

//'HH:SS(.FFF)' HOUR TO SECOND
<DateField> >= CURRENT_TIMESTAMP -+ INTERVAL 'HH:SS(.FFF)' HOUR TO SECOND

//'MI:SS(.FFF)' MINUTE TO SECOND
<DateField> >= CURRENT_TIMESTAMP -+ INTERVAL 'MI:SS(.FFF)' MINUTE TO SECOND

To demonstrate the INTERVAL format, the example below uses the INTERVAL syntax to query data gathered over the 3 days, 5 hours, 32 minutes, and 28 seconds:

1
DateField >= CURRENT_TIMESTAMP - INTERVAL '3 05:32:28' DAY TO SECOND

Percentile statistic type

The percentile statisticType is supported if the supportsPercentileStatistics layer property (in advancedQueryCapabilities ) is true . The percentile indicates the value below or above which a given percentage of values in a group of data values falls. For example, the ninetieth percentile (value 0.9) is the value below which 90 percent of the data values may be found. For percentile statistics, there are two statisticTypes , PERCENTILE_DISC (discrete) and PERCENTILE_CONT (continuous). Discrete returns a data value from within that dataset, while continuous is an interpolated value.

The orderBy statistic parameter can also be used to calculate the percentile. For example, in a set of 10 values from 1 to 10, the percentile value for 0.9 with orderBy set as ascending (ASC ) is 9, while the percentile for value 0.9 with orderBy set as descending (DESC ) is 2. The default is ASC .

Syntax

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
[
  {
    "statisticType": "<PERCENTILE_CONT | PERCENTILE_DISC>",
    "statisticParameters": {
      "value": percentile_value,
      "orderBy": "<ASC | DESC>"
    },
    "onStatisticField": "Field1",
    "outStatisticFieldName": "Out_Field_Name1"
  },
  {
    "statisticType": "<PERCENTILE_CONT | PERCENTILE_DISC>",
    "statisticParameters": {
      "value": percentile_value,
      "orderBy": "<ASC | DESC>"
    },
    "onStatisticField": "Field2",
    "outStatisticFieldName": "Out_Field_Name2"
  }
]

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
[
  {
    "statisticType": "PERCENTILE_CONT",
    "statisticParameters": {
      "value": 0.9
    },
    "onStatisticField": "NEAR_DIST",
    "outStatisticFieldName": "pop90_cont"
  },
  {
    "statisticType": "PERCENTILE_DISC",
    "statisticParameters": {
      "value": 0.9,
      "orderBy": "DESC"
    },
    "onStatisticField": "population",
    "outStatisticFieldName": "pop90_desc"
  }
]

Example usage

The following examples demonstrate various ways to create a sample query request URL for different use cases:

• Example one—Query using the text parameter on the states layer of ESRI_StateCityHighway_USA.
• Example two—Query using a WHERE statement on the same layer.
• Example three—Query strings are case sensitive. In this example, UPPER is used to make the query case insensitive.
• Example four—Query the same states layer using geometry (envelope).
• Example five—Query the states layer by both geometry (envelope) and a WHERE statement.
• Example six—Query the states layer by a WHERE statement, specifying a list of fields to return, and requesting no geometry in the results.
• Example seven—Query the states layer by text parameter and requesting the geometry with the well-known ID of 102113 (Web Mercator).
• Example eight—Query a table using a WHERE clause and return object IDs only.
• Example nine—Use groupByFieldsForStatistics and outStatistics .
• Example ten—Page through a query result using resultOffset and resultRecordCount .

Example one

The following example demonstrates a query using the text parameter on the states layer of ESRI_StateCityHighway_USA:

1
https://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer/1/query?text=Texas&f=pjson

Example two

The following example demonstrates a query using a WHERE statement on the same layer. The output is JSON format.

1
https://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer/1/query?where=STATE_NAME='Florida'&f=json

Example three

The following example demonstrates a query with strings that are case sensitive. In this example, UPPER is used to make the query case insensitive.

1
https://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer/1/query?where=UPPER(STATE_NAME)=UPPER('colorado')&f=pjson

Example four

The following example demonstrates querying the same states layer using geometry (envelope):

1
https://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer/1/query?geometry=-125.4,35.2,-118.7,43.8&geometryType=esriGeometryEnvelope&f=pjson

Example five

The following example demonstrates querying the states layer by both geometry (envelope) and a WHERE statement:

1
https://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer/1/query?geometry=-125.4,35.2,-118.7,43.8&geometryType=esriGeometryEnvelope&where=POP1999>5000000&f=pjson

Example six

The following example demonstrates querying the states layer by a WHERE statement, specifying a list of fields to return, and requesting no geometry in the results:

1
https://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer/1/query?where=POP1999>15000000&returnGeometry=false&outFields=STATE_NAME,MALES,FEMALES,POP1999&f=pjson

Example seven

The following example demonstrates querying the states layer by text parameter and requesting the geometry with the well-known ID of 102113 (Web Mercator):

1
https://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer/1/query?text=New+York&outSR=102113&f=pjson

Example eight

The following example demonstrates querying a table using a WHERE clause and return object IDs only:

1
https://sampleserver3.arcgisonline.com/ArcGIS/rest/services/SanFrancisco/311Incidents/MapServer/1/query?objectIds=&where=agree_with_incident+%3D+1&returnGeometry=true&returnIdsOnly=true&f=html

Example nine

The following example demonstrates using groupByFieldsForStatistics and outStatistics :

1
https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/3/query?where=&text=&objectIds=&time=&geometry=&geometryType=esriGeometryEnvelope&inSR=&spatialRel=esriSpatialRelIntersects&relationParam=&outFields=&returnGeometry=true&maxAllowableOffset=&outSR=&returnIdsOnly=false&returnCountOnly=false&orderByFields=&groupByFieldsForStatistics=sub_region&outStatistics=[{"statisticType":"sum","onStatisticField":"pop2007","outStatisticFieldName":"Population_2007"},{"statisticType":"avg","onStatisticField":"AVE_FAM_SZ","outStatisticFieldName":"Average_Family_Size"}]&returnZ=false&returnM=false&gdbVersion=&f=pjson

Example ten

The following example demonstrates paging through a query result using resultOffset and resultRecordCount , and requesting to skip the first 5 records and return the next 10 counties in California in order by population:

1
https://machine.domain.com/arcgis/rest/services/USA/MapServer/3/query?where=STATE_NAME='California'&outFields=Name,Population&returnGeometry=false&resultOffset=5&resultRecordCount=10&orderByFields=Population&f=pjson

JSON Response syntax

The examples below demonstrate various JSON response syntax that can be returned for the query operation.

Example one

The following example syntax is returned when returnIdsOnly and returnCountOnly are false :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "displayFieldName": "<displayFieldName>",
  "fieldAliases": {  //fieldAliases deprecated at 10
    "<fieldName1>": "<fieldAlias1>",
    "<fieldName2>": "<fieldAlias2>"
  },
  "fields": [
    {
      "name": "<fieldName1>",
      "type": "<fieldType1>",
      "alias": "<fieldAlias1>",
      "length": "<length1>"
    },
    {
      "name": "<fieldName2>",
      "type": "<fieldType2>",
      "alias": "<fieldAlias2>",
      "length": "<length2>"
    }
  ],
  "geometryType": "<geometryType>", //for layers only
  "spatialReference": <spatialReference>, //for layers only
  "hasZ": <true|false>, //added in 10.1
  "hasM": <true|false>, //added in 10.1
  "features": [ //features may include geometry for layers only
    <feature1>,
    <feature2>
  ]
}

Example two

The following example syntax is returned when returnIdsOnly is false :

1
2
3
4
5
6
7
{
  "objectIdFieldName": "<objectIdFieldName>",
  "objectIds": [
    <objectId1>,
    <objectId2>
  ]
}

Example three

The following example syntax is returned when returnCountOnly is true :

1
2
3
{
  "count": <count>
}

Example four

The following example syntax is returned when groupByFieldsForStatistics and outStatistics are specified:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "displayFieldName": "",
  "fieldAliases": {
    "alias1": "fieldAlias1",
    "alias2": "fieldAlias2"
  },
  "fields": [
    {
      "name": "fieldName1",
      "type": "fieldType1",
      "alias": "fieldAlias1",
      "length": fieldLength1
    },
    {
      "name": "fieldName2",
      "type": "fieldType2",
      "alias": "fieldAlias2",
      "length": fieldLength2
    }
  ],
  "features": [<feature1>, <feature2>] //Feature object without geometry
}

JSON Response examples

The examples below demonstrate various JSON responses that can be returned for the query operation.

Example one

The following example response is returned when returnIdsOnly and returnCountOnly are false :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
{
  "displayFieldName": "AREANAME",
  "fieldAliases": {
    "ST": "ST",
    "POP2000": "Population - 2000",
    "AREANAME": "City Name"
  },
  "fields": [
    {
      "name": "ST",
      "alias": "ST",
      "type": "esriFieldTypeString",
      "length": 2
    },
    {
      "name": "POP2000",
      "alias": "Population - 2000",
      "type": "esriFieldTypeInteger"
    },
    {
      "name": "AREANAME",
      "alias": "City Name",
      "type": "esriFieldTypeString",
      "length": 255
    }
  ],
  "geometryType": "esriGeometryPoint",
  "spatialReference": {
    "wkid": 4326
  },
  "features": [
    {
      "attributes": {
        "ST": "CA",
        "POP2000": 3694820,
        "AREANAME": "Los Angeles"
      },
      "geometry": {
        "x": -118.37,
        "y": 34.086
      }
    },
    {
      "attributes": {
        "ST": "CA",
        "POP2000": 461522,
        "AREANAME": "Long Beach"
      },
      "geometry": {
        "x": -118.15,
        "y" : 33.80
      }
    }
  ]
}

Example two

The following example response is returned when returnIdsOnly is true :

1
2
3
4
5
6
7
8
9
10
11
{
  "objectIdFieldName": "objectid",
  "objectIds": [
    1,
    2,
    3,
    4,
    5,
    7
  ]
}

Example three

The following example response is returned when returnCountOnly is true :

1
2
3
{
  "count":48
}

Example four

The following example response is returned when groupByFieldsForStatistics and outStatistics are specified:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
{
  "displayFieldName": "",
  "fieldAliases": {
    "sub_region": "SUB_REGION",
    "Population_2007": "Population_2007",
    "Average_Family_Size": "Average_Family_Size"
  },
  "fields": [
    {
      "name": "sub_region",
      "type": "esriFieldTypeString",
      "alias": "SUB_REGION",
      "length": 20
    },
    {
      "name": "Population_2007",
      "type": "esriFieldTypeDouble",
      "alias": "Population_2007"
    },
    {
      "name": "Average_Family_Size",
      "type": "esriFieldTypeDouble",
      "alias": "Average_Family_Size"
    }
  ],
  "features": [
    {
      "attributes": {
        "sub_region": "Pacific",
        "Population_2007": 49731702,
        "Average_Family_Size": 3.2439999999999998
      }
    },
    {
      "attributes": {
        "sub_region": "Mountain",
        "Population_2007": 21492235,
        "Average_Family_Size": 3.165
      }
    },
    {
      "attributes": {
        "sub_region": "New England",
        "Population_2007": 14515009,
        "Average_Family_Size": 3.0249999999999999
      }
    },
    {
      "attributes": {
        "sub_region": "West North Central",
        "Population_2007": 20384497,
        "Average_Family_Size": 3.044285714285714
      }
    },
    {
      "attributes": {
        "sub_region": "East North Central",
        "Population_2007": 47176974,
        "Average_Family_Size": 3.0940000000000003
      }
    },
    {
      "attributes": {
        "sub_region": "Middle Atlantic",
        "Population_2007": 41116339,
        "Average_Family_Size": 3.1566666666666663
      }
    },
    {
      "attributes": {
        "sub_region": "South Atlantic",
        "Population_2007": 58943344,
        "Average_Family_Size": 3.0333333333333332
      }
    },
    {
      "attributes": {
        "sub_region": "East South Central",
        "Population_2007": 18077309,
        "Average_Family_Size": 3.0275000000000003
      }
    },
    {
      "attributes": {
        "sub_region": "West South Central",
        "Population_2007": 34910821,
        "Average_Family_Size": 3.1124999999999998
      }
    }
  ]
}