ArcGIS REST JS
ArcGIS REST API JavaScript Client

queryFeatures

Function 
import { queryFeatures } from '@esri/arcgis-rest-feature-layer';
//
queryFeatures({
  url: "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/3",
  where: "STATE_NAME = 'Alaska'"
})
  .then(result)

Query a feature service. See REST Documentation for more information.

Parameters

Parameter Type Default Notes
requestOptions Required IQueryFeaturesOptions

Options for the request

Available requestOptions

Property Type Notes
url Inherited string

Layer service url.
distance Optional number
f Optional "json" | "geojson" | "pbf"

Response format. Defaults to "json" NOTE: for "pbf" you must also supply rawResponse: true and parse the response yourself using response.arrayBuffer()
gdbVersion Optional string
geometryPrecision Optional number
groupByFieldsForStatistics Optional string
historicMoment Optional number
inSR Optional string | ISpatialReference
maxAllowableOffset Optional number
multipatchOption Optional "xyFootprint"
objectIds Optional number[] | number
orderByFields Optional string
outFields Optional "*" | string[] | string

Attribute fields to include in the response. Defaults to "*"
outSR Optional string | ISpatialReference
outStatistics Optional IStatisticDefinition[] | IStatisticDefinition
quantizationParameters Optional any
relationParam Optional string
resultOffset Optional number
resultRecordCount Optional number
resultType Optional "none" | "standard" | "tile"
returnCentroid Optional boolean
returnCountOnly Optional boolean
returnDistinctValues Optional boolean
returnExceededLimitFeatures Optional boolean
returnExtentOnly Optional boolean
returnGeometry Optional boolean
returnIdsOnly Optional boolean
returnM Optional boolean
returnTrueCurves Optional false
returnZ Optional boolean
sqlFormat Optional "none" | "standard" | "native"
time Optional number | number[] | number
units Optional Units
authentication Optional Inherited IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.
credentials Optional Inherited RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.
geometry Optional Inherited IGeometry
geometryType Optional Inherited GeometryType
headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.
hideToken Optional Inherited boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.
httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.
maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.
params Optional Inherited IParams

Additional parameters to pass in the request.
portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.
rawResponse Optional Inherited boolean

Return the raw response
spatialRel Optional Inherited SpatialRelationship
where Optional Inherited string

A where clause for the query. Defaults to "1=1"

Returns

A Promise that will resolve with the query response.

Promise<IQueryFeaturesResponse | IQueryResponse>
Function defined in packages/arcgis-rest-feature-layer/src/query.ts:149