Interface
feature query request options. See REST Documentation for more information.
Properties
Property | Type | Notes |
---|---|---|
authentication inherited | string | IAuthenticationManager | The instance of |
credentials inherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
number | ||
"json" | "geojson" | "pbf" | Response format. Defaults to "json"
NOTE: for "pbf" you must also supply | |
string | ||
geometry inherited | ||
number | ||
geometryType inherited | ||
string | ||
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. |
number | ||
httpMethod inherited | The HTTP method to send the request with. | |
string | ISpatialReference | ||
number | ||
maxUrlLength inherited | number | If the length of a GET request's URL exceeds |
"xyFootprint" | ||
number[] | ||
string | ||
string[] | "*" | Attribute fields to include in the response. Defaults to "*" | |
string | ISpatialReference | ||
params inherited | 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'. |
any | ||
rawResponse inherited | boolean | Return the raw response |
string | ||
number | ||
number | ||
"none" | "standard" | "tile" | ||
boolean | ||
boolean | ||
boolean | ||
boolean | ||
boolean | ||
boolean | ||
boolean | ||
boolean | ||
"" | ||
boolean | ||
signal inherited | AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. |
spatialRel inherited | ||
"none" | "standard" | "native" | ||
suppressWarnings inherited | boolean | Suppress any ArcGIS REST JS related warnings for this request. |
number | number[] | ||
url inherited | string | Layer service url. |
where inherited | string | A where clause for the query. Defaults to "1=1" |
credentials
credentials: RequestCredentials
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
f
f: "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()
geometry
geometry: IGeometry
geometryType
geometryType: GeometryType
headers
headers: { [key: string]: any }
Additional Headers to pass into the request.
Type declaration
- [key: string]: any
hideToken
hideToken: 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
httpMethod: HTTPMethods
The HTTP method to send the request with.
inSR
inSR: string | ISpatialReference
maxUrlLength
maxUrlLength: number
If the length of a GET request's URL exceeds maxUrlLength
the request will use POST instead.
outFields
outFields: string[] | "*"
Attribute fields to include in the response. Defaults to "*"
outSR
outSR: string | ISpatialReference
outStatistics
outStatistics: IStatisticDefinition[]
params
params: IParams
Additional parameters to pass in the request.
portal
portal: 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'.
signal
signal: AbortSignal
An AbortSignal object instance; allows you to abort a request and via an AbortController.
spatialRel
spatialRel: SpatialRelationship
suppressWarnings
suppressWarnings: boolean
Suppress any ArcGIS REST JS related warnings for this request.
units
units: Units
where
where: string
A where clause for the query. Defaults to "1=1"
authentication: string | IAuthenticationManager
The instance of
ApiKey
,ArcGISIdentityManager
orApplicationSession
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.