Interface
Properties
Property | Type | Notes |
---|---|---|
string[] | Optional parameter to specify an array of string values that describe what derivative variables to include in the output. | |
authentication inherited | string | IAuthenticationManager | The instance of |
string | View a description for a single data collection within a given country. If not specified, will return a list of data collections that can be run in any country. | |
credentials inherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
string | ||
endpoint inherited | string | Any ArcGIS Geoenrichment service (example: https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment ) |
headers inherited | { [key: string]: any } | Additional Headers to pass into the request. |
hideToken inherited | 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 inherited | The HTTP method to send the request with. | |
maxUrlLength inherited | number | If the length of a GET request's URL exceeds |
params inherited | Additional parameters to pass in the request. | |
portal inherited | 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 inherited | boolean | Return the raw response |
signal inherited | AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. |
boolean | Optional parameter to return only values that are not NULL in the output response. | |
suppressWarnings inherited | boolean | Suppress any ArcGIS REST JS related warnings for this request. |
authentication
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.
countryCode
countryCode: string
View a description for a single data collection within a given country. If not specified, will return a list of data collections that can be run in any country.
credentials
credentials: RequestCredentials
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
endpoint
endpoint: string
Any ArcGIS Geoenrichment service (example: https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment )
headers
headers: { [key: string]: any }
Additional Headers to pass into the request.
Type declaration
- [key: string]: any
hideToken
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
httpMethod: HTTPMethods
The HTTP method to send the request with.
maxUrlLength
maxUrlLength: number
If the length of a GET request's URL exceeds maxUrlLength
the request will use POST instead.
portal
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'.
signal
signal: AbortSignal
An AbortSignal object instance; allows you to abort a request and via an AbortController.
suppressNullValues
suppressNullValues: boolean
Optional parameter to return only values that are not NULL in the output response.
suppressWarnings
suppressWarnings: boolean
Suppress any ArcGIS REST JS related warnings for this request.
addDerivativeVariables: string[]
Optional parameter to specify an array of string values that describe what derivative variables to include in the output.