Skip to content

Interface

Inheritance: ISearchOptionsIRequestOptionsIPagingParams

Properties

Hide inherited properties
PropertyTypeNotes
string | IAuthenticationManager

The instance of ArcGISIdentityManager, ApplicationCredentialsManager or 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.

categoriesstring | string[]

A JSON array or comma-separated list of up to eight org content categories to search items.

categoryFiltersstring

A comma-separated list of up to three category terms to search for items that have matching categories.

countFieldsstring

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.

countSizenumber

The maximum number of field values to count for each countFields. The default value is 10, and the maximum number allowed is 200.

credentials
inherited
RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

filterstring

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
HTTPMethods

The HTTP method to send the request with.

maxUrlLength
inherited
number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

num
inherited
number
params
inherited
IParams

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'.

qstring | 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.

sortFieldstring

Field to sort by.

sortOrder"asc" | "desc"

Describes whether order returns in ascending or descending order. The default is ascending.

start
inherited
number
boolean

Suppress any ArcGIS REST JS related warnings for this request.

authentication

optionalinherited
Interface Property

categories

optional
Interface Property

categoryFilters

optional
Interface Property

countFields

optional
Interface Property

countSize

optional
Interface Property

credentials

optionalinherited
Interface Property

filter

optional
Interface Property

headers

optionalinherited
Interface Property

hideToken

optionalinherited
Interface Property

httpMethod

optionalinherited
Interface Property

maxUrlLength

optionalinherited
Interface Property

num

optionalinherited
Interface Property
num: number
Inherited from IPagingParams.num

params

optionalinherited
Interface Property

portal

optionalinherited
Interface Property

q

Interface Property

rawResponse

optionalinherited
Interface Property

signal

optionalinherited
Interface Property

sortField

optional
Interface Property

sortOrder

optional
Interface Property

start

optionalinherited
Interface Property
start: number
Inherited from IPagingParams.start

suppressWarnings

optionalinherited
Interface Property

Methods

Hide inherited methods
MethodReturnsNotes
request(url, requestOptions)
inherited
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).

request

optionalinherited
Interface Method
request(urlstring, requestOptionsInternalRequestOptions): 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).

Parameters
ParameterTypeNotes
urlstring
requestOptionsInternalRequestOptions
Returns 
Promise<any>

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.