Query service parameters
The following table provides details about the query service parameters.
Parameter | Details |
|---|---|
Where | A where clause for the query filter. Any legal SQL where clause operating on the fields is allowed.Example: |
Text | A literal text search. If the layer has a display field associated with it, the server searches for this text in this field. Example: |
Object IDs | The object IDs to be queried in this layer or table. Syntax: Example: |
Time | The time instant or the time extant to query. Time instant Syntax: Example: Time extant Syntax: Example: A null value specified for start time or end time will represent infinity for start time or end time respectively. |
Input Geometry | The geometry to be applied 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. For envelopes and points, you can also specify the geometry with a simpler comma-separated syntax. Syntax:
Examples:
|
Geometry Type | 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:
|
Input Spatial Reference | The spatial reference of the input geometry. This can be specified as either a well-known ID or as a spatial reference JSON object. If the input spatial reference ( |
Spatial Relationship | 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 Values:
|
Relation | The spatial relate function that can be applied while performing the query operation. An example for this spatial relate function is For more information on this spatial relate function please refer to the documentation for the spatial relate function. |
Out Fields | 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:
You can also specify the wildcard ( Example: Wildcard example: |
Return Geometry | If Values:
|
Return True Curves |
|
Max Allowable Offset | This option can be used to specify the The Example: |
Geometry Precision | 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: |
Output Spatial Reference | 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 |
Return IDs Only | If Note: 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 Values:
|
Return Count Only | If Values:
|
Order By Fields | Orders the features or records in ascending ( Note:
Syntax: Example: |
Group By Fields | Groups the features or records by field name to calculate statistics. Note: Syntax: Example: |
Output Statistics | The definitions for one or more field-based statistics to be calculated. Note:
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"
}
]
|
ReturnZ | If Note: This parameter only applies if |
ReturnM | If Note: This parameter only applies if |
Geodatabase Version Name | The Geodatabase version to query. This parameter applies only if the Syntax: Example: |
Return Distinct Values | If Syntax: Example: |
Result Offset |
|
Result Record Count |
|
Format | The response format. The default response format is Note:
Values: Values: |