Interface
Properties
Property | Type | Notes |
---|---|---|
authentication inherited | string | IAuthenticationManager | The instance of |
string | string[] | A JSON array or comma-separated list of up to eight org content categories to search items. | |
string | A comma-separated list of up to three category terms to search for items that have matching categories. | |
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. | |
number | The maximum number of field values to count for each | |
credentials inherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
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. | |
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 |
num inherited | number | |
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'. |
string | SearchQueryBuilder | The query string to search against. | |
rawResponse inherited | boolean | Return the raw response |
signal inherited | AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. |
string | Field to sort by. | |
"asc" | "desc" | Describes whether order returns in ascending or descending order. The default is ascending. | |
start inherited | number | |
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.
categories
categories: string | string[]
A JSON array or comma-separated list of up to eight org content categories to search items.
categoryFilters
categoryFilters: string
A comma-separated list of up to three category terms to search for items that have matching categories.
countFields
countFields: 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.
countSize
countSize: number
The maximum number of field values to count for each countFields
. The default value is 10, and the maximum number allowed is 200.
credentials
credentials: RequestCredentials
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
filter
filter: 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.
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.
num
num: number
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'.
q
Interface Propertyq: string | SearchQueryBuilder
The query string to search against.
signal
signal: AbortSignal
An 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: number
suppressWarnings
suppressWarnings: boolean
Suppress any ArcGIS REST JS related warnings for this request.