Interface
Properties
| Property | Type | Notes |
|---|---|---|
authenticationinherited | string | IAuthenticationManager | The instance of |
categoriesinherited | string | string[] | A JSON array or comma-separated list of up to eight org content categories to search items. |
categoryFiltersinherited | string | A comma-separated list of up to three category terms to search for items that have matching categories. |
countFieldsinherited | string | A comma-separated list of fields to count. The maximum count fields allowed per request is three. Supported count fields are tags, type, access, contentstatus, and categories. |
countSizeinherited | number | The maximum number of field values to count for each |
credentialsinherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
filterinherited | string | Structured filtering is accomplished by specifying a field name followed by a colon and the term you are searching for with double quotation marks. It allows the passing in of application-level filters based on the context. Use an exact keyword match of the expected value for the specified field. Partially matching the filter keyword will not return meaningful results. |
string | ||
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. |
httpMethodinherited | The HTTP method to send the request with. | |
maxUrlLengthinherited | number | If the length of a GET request's URL exceeds |
numinherited | number | |
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'. |
qinherited | string | SearchQueryBuilder | The query string to search against. |
rawResponseinherited | boolean | Return the raw response |
signalinherited | AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. |
sortFieldinherited | string | Field to sort by. |
sortOrderinherited | "asc" | "desc" | Describes whether order returns in ascending or descending order. The default is ascending. |
startinherited | number | |
suppressWarningsinherited | boolean | Suppress any ArcGIS REST JS related warnings for this request. |
authentication
authentication: string | IAuthenticationManagerThe 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.
categories
categories: string | string[]A JSON array or comma-separated list of up to eight org content categories to search items.
categoryFilters
categoryFilters: stringA comma-separated list of up to three category terms to search for items that have matching categories.
countFields
countFields: stringA comma-separated list of fields to count. The maximum count fields allowed per request is three. Supported count fields are tags, type, access, contentstatus, and categories.
countSize
countSize: numberThe maximum number of field values to count for each countFields. The default value is 10, and the maximum number allowed is 200.
credentials
credentials: RequestCredentialsA string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
filter
filter: stringStructured filtering is accomplished by specifying a field name followed by a colon and the term you are searching for with double quotation marks. It allows the passing in of application-level filters based on the context. Use an exact keyword match of the expected value for the specified field. Partially matching the filter keyword will not return meaningful results.
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.
num
num: numberportal
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.
sortOrder
sortOrder: "asc" | "desc"Describes whether order returns in ascending or descending order. The default is ascending.
start
start: numbersuppressWarnings
suppressWarnings: booleanSuppress any ArcGIS REST JS related warnings for this request.