Interface
Options for the request() method.
Properties
| Property | Type | Notes |
|---|---|---|
string | IAuthenticationManager | The instance of | |
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 | |
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
authentication: string | IAuthenticationManagerThe 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
credentials: RequestCredentialsA string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
headers
headers: { [key: string]: any }Additional Headers to pass into the request.
Type declaration
- [key: string]: any
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.
maxUrlLength
maxUrlLength: numberIf the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.
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'.
rawResponse
rawResponse: booleanReturn the raw response
signal
signal: AbortSignalAn AbortSignal object instance; allows you to abort a request and via an AbortController.