Interface
Options for the request() method.
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. |
endpointinherited | string | Any ArcGIS Geoenrichment service (example: https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment ) |
featureLimit | number | Limits the number of features that are returned from the geographyQuery parameter. |
featureOffset | number | Starts the results on the number of the records specified. |
generalizationLevel | number | Integer that specifies the level of generalization or detail in the area representations of the administrative boundary or standard geographic data layers. |
geographyIDs | string[] | Specify which IDs for the standard geography layers are being queried or searched. |
geographyLayers | string | string[] | Specify which standard geography layers are being queried or searched. |
geographyQuery | string | Specify the text to query and search the standard geography layers specified. |
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. |
langCode | string | Specifies the language you wish to receive your GeoEnrichment results. |
maxUrlLengthinherited | number | If the length of a GET request's URL exceeds |
optionalCountryDataset | string | Specify a specific dataset within a defined country. |
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). |
returnCentroids | boolean | Request the output geometry to return the center point for each feature. |
returnGeometry | boolean | Request the output geometries in the response. |
returnSubGeographyLayer | boolean | Return all the subgeographic areas that are within a parent geography. |
signalinherited | AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. |
sourceCountry | string | Specify the source country for the search. |
subGeographyLayer | string | Return all the subgeographic areas that are within a parent geography. |
subGeographyQuery | string | Filter the results of the subgeography features that are returned by a search term. |
suppressWarningsinherited | boolean | Suppress any ArcGIS REST JS related warnings for this request. |
useFuzzySearch | boolean | Define if text provided in the geographyQuery parameter should utilize fuzzy search logic. |
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.
endpoint
endpoint: stringAny ArcGIS Geoenrichment service (example: https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment )
featureLimit
featureLimit: numberLimits the number of features that are returned from the geographyQuery parameter.
featureOffset
featureOffset: numberStarts the results on the number of the records specified.
generalizationLevel
generalizationLevel: numberInteger that specifies the level of generalization or detail in the area representations of the administrative boundary or standard geographic data layers.
geographyIDs
geographyIDs: string[]Specify which IDs for the standard geography layers are being queried or searched.
geographyLayers
geographyLayers: string | string[]Specify which standard geography layers are being queried or searched.
geographyQuery
geographyQuery: stringSpecify the text to query and search the standard geography layers specified.
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.
langCode
langCode: stringSpecifies the language you wish to receive your GeoEnrichment results.
maxUrlLength
maxUrlLength: numberIf the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.
optionalCountryDataset
optionalCountryDataset: stringSpecify a specific dataset within a defined country.
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>returnCentroids
returnCentroids: booleanRequest the output geometry to return the center point for each feature.
returnGeometry
returnGeometry: booleanRequest the output geometries in the response.
returnSubGeographyLayer
returnSubGeographyLayer: booleanReturn all the subgeographic areas that are within a parent geography.
signal
signal: AbortSignalAn AbortSignal object instance; allows you to abort a request and via an AbortController.
sourceCountry
sourceCountry: stringSpecify the source country for the search.
subGeographyLayer
subGeographyLayer: stringReturn all the subgeographic areas that are within a parent geography.
subGeographyQuery
subGeographyQuery: stringFilter the results of the subgeography features that are returned by a search term.
suppressWarnings
suppressWarnings: booleanSuppress any ArcGIS REST JS related warnings for this request.