Skip to content

Interface

query all features request options. See REST Documentation for more information.

Inheritance: IQueryAllFeaturesOptionsISharedQueryOptions

Properties

Hide inherited properties
PropertyTypeNotes
string | IAuthenticationManager

The instance of ArcGISIdentityManager, ApplicationCredentialsManager or APIKeyManager to use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.

credentials
inherited
RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

distancenumber
f"json" | "geojson"

Response format. Defaults to "json" NOTE: for "pbf" you must also supply rawResponse: true and parse the response yourself using response.arrayBuffer()

gdbVersionstring
geometry
inherited
IGeometry
geometryPrecisionnumber
geometryType
inherited
GeometryType
groupByFieldsForStatisticsstring
headers
inherited
{ [key: string]: any }

Additional Headers to pass into the request.

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

historicMomentnumber
httpMethod
inherited
HTTPMethods

The HTTP method to send the request with.

inSRstring | ISpatialReference
maxAllowableOffsetnumber
maxUrlLength
inherited
number

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

multipatchOption"xyFootprint"
objectIdsnumber[]
orderByFieldsstring
outFieldsstring[] | "*"

Attribute fields to include in the response. Defaults to "*"

outSRstring | ISpatialReference
outStatisticsIStatisticDefinition[]
params
inherited
IParams

Additional parameters to pass in the request.

portal
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'.

quantizationParametersany
rawResponse
inherited
boolean

Return the raw response

relationParamstring
resultOffsetnumber
resultRecordCountnumber
resultType"none" | "standard" | "tile"
returnExceededLimitFeatures""
returnGeometryboolean
returnMboolean
returnTrueCurves""
returnZboolean
signal
inherited
AbortSignal

An AbortSignal object instance; allows you to abort a request and via an AbortController.

spatialRel
inherited
SpatialRelationship
sqlFormat"none" | "standard" | "native"
boolean

Suppress any ArcGIS REST JS related warnings for this request.

timenumber | number[]
unitsUnits
url
inherited
string

Layer service url.

where
inherited
string

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

authentication

optionalinherited
Interface Property

credentials

optionalinherited
Interface Property

distance

optional
Interface Property
distance: number

f

optional
Interface Property

gdbVersion

optional
Interface Property
gdbVersion: string

geometry

optionalinherited
Interface Property
geometry: IGeometry

geometryPrecision

optional
Interface Property
geometryPrecision: number

geometryType

optionalinherited
Interface Property

groupByFieldsForStatistics

optional
Interface Property
groupByFieldsForStatistics: string

headers

optionalinherited
Interface Property

hideToken

optionalinherited
Interface Property

historicMoment

optional
Interface Property
historicMoment: number

httpMethod

optionalinherited
Interface Property

inSR

optional
Interface Property
inSR: string | ISpatialReference

maxAllowableOffset

optional
Interface Property
maxAllowableOffset: number

maxUrlLength

optionalinherited
Interface Property

multipatchOption

optional
Interface Property
multipatchOption: "xyFootprint"

objectIds

optional
Interface Property
objectIds: number[]

orderByFields

optional
Interface Property
orderByFields: string

outFields

optional
Interface Property

outSR

optional
Interface Property
outSR: string | ISpatialReference

outStatistics

optional
Interface Property
outStatistics: IStatisticDefinition[]

params

optionalinherited
Interface Property

portal

optionalinherited
Interface Property

quantizationParameters

optional
Interface Property
quantizationParameters: any

rawResponse

optionalinherited
Interface Property

relationParam

optional
Interface Property
relationParam: string

resultOffset

optional
Interface Property
resultOffset: number

resultRecordCount

optional
Interface Property
resultRecordCount: number

resultType

optional
Interface Property
resultType: "none" | "standard" | "tile"

returnExceededLimitFeatures

optional
Interface Property
returnExceededLimitFeatures: ""

returnGeometry

optional
Interface Property
returnGeometry: boolean

returnM

optional
Interface Property
returnM: boolean

returnTrueCurves

optional
Interface Property
returnTrueCurves: ""

returnZ

optional
Interface Property
returnZ: boolean

signal

optionalinherited
Interface Property

spatialRel

optionalinherited
Interface Property

sqlFormat

optional
Interface Property
sqlFormat: "none" | "standard" | "native"

suppressWarnings

optionalinherited
Interface Property

time

optional
Interface Property
time: number | number[]

units

optional
Interface Property
units: Units

url

inherited
Interface Property

where

optionalinherited
Interface Property

Methods

Hide inherited methods
MethodReturnsNotes
request(url, requestOptions)
inherited
Promise<any>

Override the default function for making the request. This is mainly useful for testing purposes (i.e. so you can pass in a spy).

request

optionalinherited
Interface Method
request(urlstring, requestOptionsInternalRequestOptions): Promise<any>

Override the default function for making the request. This is mainly useful for testing purposes (i.e. so you can pass in a spy).

Parameters
ParameterTypeNotes
urlstring
requestOptionsInternalRequestOptions
Returns 
Promise<any>

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.