Interface
Options for the request() method.
Properties
| Property | Type | Notes |
|---|---|---|
addDerivativeVariables | boolean | Specify an array of string values that describe what derivative variables to include in the output |
analysisVariables | string[] | Specify a subset of variables to be returned from one or more Data Collections |
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. |
dataCollections | string[] | A Data Collection is a preassembled list of attributes that will be used to enrich the input features. Enrichment attributes can describe various types of information such as demographic characteristics and geographic context of the locations or areas submitted as input features in studyAreas. |
endpointinherited | string | Any ArcGIS Geoenrichment service (example: https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment ) |
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. |
httpMethodinherited | HTTPMethods | The HTTP method to send the request with. |
inSR | number | Define the input geometries in the studyAreas parameter in a specified spatial reference system |
maxUrlLengthinherited | number | If the length of a GET request's URL exceeds |
outSR | number | Request the output geometries in a specified spatial reference system |
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'. |
rawResponseinherited | boolean | Return the raw response |
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). |
returnGeometry | boolean | Request the output geometries in the response |
signalinherited | AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. |
studyAreas | any[] | Defines the area on a map which is being analyzed |
suppressWarningsinherited | boolean | Suppress any ArcGIS REST JS related warnings for this request. |
addDerivativeVariables
addDerivativeVariables: booleanSpecify an array of string values that describe what derivative variables to include in the output
analysisVariables
analysisVariables: string[]Specify a subset of variables to be returned from one or more Data Collections
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.
dataCollections
dataCollections: string[]A Data Collection is a preassembled list of attributes that will be used to enrich the input features. Enrichment attributes can describe various types of information such as demographic characteristics and geographic context of the locations or areas submitted as input features in studyAreas.
endpoint
endpoint: stringAny ArcGIS Geoenrichment service (example: https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment )
headers
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: numberDefine the input geometries in the studyAreas parameter in a specified spatial reference system
maxUrlLength
maxUrlLength: numberIf the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.
outSR
outSR: numberRequest the output geometries in a specified spatial reference system
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>returnGeometry
returnGeometry: booleanRequest the output geometries in the response
signal
signal: AbortSignalAn AbortSignal object instance; allows you to abort a request and via an AbortController.
suppressWarnings
suppressWarnings: booleanSuppress any ArcGIS REST JS related warnings for this request.