IRequestOptions

Interface

Options for the request() method.

Properties

PropertyTypeNotes

The instance of ApiKey, ArcGISIdentityManager or ApplicationSession 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.

RequestCredentials

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

{ [key: string]: any }

Additional Headers to pass into the request.

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.

The HTTP method to send the request with.

number

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

Additional parameters to pass in the request.

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

boolean

Return the raw response

AbortSignal

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

boolean

Suppress any ArcGIS REST JS related warnings for this request.

authentication

optional
Interface Property
authentication: string | IAuthenticationManager

The instance of ApiKey, ArcGISIdentityManager or ApplicationSession 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

optional
Interface Property
credentials: RequestCredentials

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

headers

optional
Interface Property
headers: { [key: string]: any }

Additional Headers to pass into the request.

Type declaration
  • [key: string]: any

hideToken

optional
Interface Property
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

optional
Interface Property
httpMethod: HTTPMethods

The HTTP method to send the request with.

maxUrlLength

optional
Interface Property
maxUrlLength: number

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

params

optional
Interface Property
params: IParams

Additional parameters to pass in the request.

portal

optional
Interface Property
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'.

rawResponse

optional
Interface Property
rawResponse: boolean

Return the raw response

signal

optional
Interface Property
signal: AbortSignal

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

suppressWarnings

optional
Interface Property
suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

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