Skip to content

Interface

Base options interface for making authenticated requests for items.

Inheritance: IItemStatusOptionsIUserItemOptions

Properties

Hide inherited properties
PropertyTypeNotes
IAuthenticationManager

The instance of @esri/arcgis-rest-request!ArcGISIdentityManager , @esri/arcgis-rest-request!ApplicationCredentialsManager or @esri/arcgis-rest-request!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.

credentials
inherited
RequestCredentials

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

format"html"

The response format. The default and the only response format for this resource is HTML.

headers
inherited
{}

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.

id
inherited
string

Unique identifier of the item.

jobIdstring

The job ID returned during publish, generateFeatures, export, and createService calls.

jobType"publish" | "generateFeatures" | "export" | "createService"

The type of asynchronous job for which the status has to be checked. Default is none, which check the item's status.

maxUrlLength
inherited
number

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

owner
inherited
string

Item owner username. If not present, authentication.getUsername() is utilized.

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

rawResponse
inherited
boolean

Return the raw response

request
inherited
(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).

signal
inherited
AbortSignal

An AbortSignal object instance; allows you to abort a request and via an AbortController.

boolean

Suppress any ArcGIS REST JS related warnings for this request.

authentication

inheritedinherited
Interface Property
authentication: IAuthenticationManager

The instance of @esri/arcgis-rest-request!ArcGISIdentityManager , @esri/arcgis-rest-request!ApplicationCredentialsManager or @esri/arcgis-rest-request!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.

credentials

optionalinheritedinherited
Interface Property
credentials: RequestCredentials

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

format

optional
Interface Property
format: "html"

The response format. The default and the only response format for this resource is HTML.

headers

optionalinheritedinherited
Interface Property
headers: {}

Additional Headers to pass into the request.

Type declaration

    hideToken

    optionalinheritedinherited
    Interface Property
    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

    optionalinheritedinherited
    Interface Property
    httpMethod: HTTPMethods

    The HTTP method to send the request with.

    id

    inheritedinherited
    Interface Property
    id: string

    Unique identifier of the item.

    Inherited from IUserItemOptions.id

    jobId

    optional
    Interface Property
    jobId: string

    The job ID returned during publish, generateFeatures, export, and createService calls.

    jobType

    optional
    Interface Property
    jobType: "publish" | "generateFeatures" | "export" | "createService"

    The type of asynchronous job for which the status has to be checked. Default is none, which check the item's status.

    maxUrlLength

    optionalinheritedinherited
    Interface Property
    maxUrlLength: number

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

    owner

    optionalinheritedinherited
    Interface Property
    owner: string

    Item owner username. If not present, authentication.getUsername() is utilized.

    Inherited from IUserItemOptions.owner

    params

    optionalinheritedinherited
    Interface Property
    params: IParams

    Additional parameters to pass in the request.

    portal

    optionalinheritedinherited
    Interface Property
    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'.

    rawResponse

    optionalinheritedinherited
    Interface Property
    rawResponse: boolean

    Return the raw response

    request

    optionalinheritedinherited
    Interface Property
    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).

    Type declaration

    signal

    optionalinheritedinherited
    Interface Property
    signal: AbortSignal

    An AbortSignal object instance; allows you to abort a request and via an AbortController.

    suppressWarnings

    optionalinheritedinherited
    Interface Property
    suppressWarnings: boolean

    Suppress any ArcGIS REST JS related warnings for this request.

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