Interface
query all features request options. See REST Documentation for more information.
Properties
| Property | Type | Notes |
|---|---|---|
authenticationinherited | string | IAuthenticationManager | The instance of |
credentialsinherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
distance | number | |
f | "json" | "geojson" | Response format. Defaults to "json"
NOTE: for "pbf" you must also supply |
gdbVersion | string | |
geometryinherited | IGeometry | |
geometryPrecision | number | |
geometryTypeinherited | GeometryType | |
groupByFieldsForStatistics | string | |
headersinherited | {} | Additional Headers to pass into the request. |
hideTokeninherited | 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. |
historicMoment | number | |
httpMethodinherited | HTTPMethods | The HTTP method to send the request with. |
inSR | string | ISpatialReference | |
maxAllowableOffset | number | |
maxUrlLengthinherited | number | If the length of a GET request's URL exceeds |
multipatchOption | "xyFootprint" | |
objectIds | number[] | |
orderByFields | string | |
outFields | string[] | "*" | Attribute fields to include in the response. Defaults to "*" |
outSR | string | ISpatialReference | |
outStatistics | IStatisticDefinition[] | |
paramsinherited | IParams | Additional parameters to pass in the request. |
portalinherited | 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'. |
quantizationParameters | any | |
rawResponseinherited | boolean | Return the raw response |
relationParam | string | |
requestinherited | (url: string, requestOptions: InternalRequestOptions) => 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). |
resultOffset | number | |
resultRecordCount | number | |
resultType | "none" | "standard" | "tile" | |
returnExceededLimitFeatures | "" | |
returnGeometry | boolean | |
returnM | boolean | |
returnTrueCurves | "" | |
returnZ | boolean | |
signalinherited | AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. |
spatialRelinherited | SpatialRelationship | |
sqlFormat | "native" | "none" | "standard" | |
suppressWarningsinherited | boolean | Suppress any ArcGIS REST JS related warnings for this request. |
time | number | number[] | |
units | Units | |
urlinherited | string | Layer service url. |
whereinherited | string | A where clause for the query. Defaults to "1=1" |
authentication
authentication: string | IAuthenticationManagerThe instance of @esri/arcgis-rest-request!ArcGISIdentityManager , @esri/arcgis-rest-request!ApplicationCredentialsManager or @esri/arcgis-rest-request!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
credentials: RequestCredentialsA string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
f
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()
geometry
geometry: IGeometrygeometryType
geometryType: GeometryTypeheaders
headers: {}Additional Headers to pass into the request.
Type declaration
hideToken
hideToken: booleanPrevents 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: HTTPMethodsThe HTTP method to send the request with.
inSR
inSR: string | ISpatialReferencemaxUrlLength
maxUrlLength: numberIf 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 | ISpatialReferenceoutStatistics
outStatistics: IStatisticDefinition[]params
params: IParamsAdditional parameters to pass in the request.
portal
portal: stringBase 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'.
request
request: (url: string, requestOptions: InternalRequestOptions) => 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).
Type declaration
function(url: string, requestOptions: InternalRequestOptions): Promise<any>Parameters
| Parameter | Type |
|---|---|
url | string |
request | InternalRequestOptions |
Returns
Promise<any>signal
signal: AbortSignalAn AbortSignal object instance; allows you to abort a request and via an AbortController.
spatialRel
spatialRel: SpatialRelationshipsuppressWarnings
suppressWarnings: booleanSuppress any ArcGIS REST JS related warnings for this request.
units
units: Unitswhere
where: stringA where clause for the query. Defaults to "1=1"