Interface
Options for getCategory.
Properties
| Property | Type | Notes |
|---|---|---|
authenticationinherited | string | IAuthenticationManager | The instance of |
string | ||
credentialsinherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
finherited | "json" | "pjson" | The requested response format - either |
headersinherited | { [key: string]: any } | 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. |
maxUrlLengthinherited | number | If the length of a GET request's URL exceeds |
paramsinherited | 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 |
signalinherited | AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. |
suppressWarningsinherited | boolean | Suppress any ArcGIS REST JS related warnings for this request. |
tokeninherited | string | The authentication token with the |
credentials
credentials: RequestCredentialsA string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
f
f: "json" | "pjson"The requested response format - either json or pjson (pretty json).
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.
maxUrlLength
maxUrlLength: numberIf the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.
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'.
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.
token
token: stringThe authentication token with the premium:user:places privilege, used to access the Places service.
The token parameter can be either an API Key or short-lived token. SeeArcGIS security
documentationfor more information on authenticating with a token or API key.
Alternatively, you can supply a token in the request header with one of the following keys using the "Bearer" scheme:
Authorization: Bearer <YOUR_TOKEN>X-Esri-Authorization: Bearer <YOUR_TOKEN>
authentication: string | IAuthenticationManagerThe instance of
ApiKey,ArcGISIdentityManagerorApplicationSessionto use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.