Skip to content

Interface

Inheritance: IUpdateItemOptionsICreateUpdateItemOptions

Properties

Hide inherited properties
PropertyTypeNotes
async
inherited
boolean

If true, the file is uploaded asynchronously. If false, the file is uploaded synchronously.

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.

dataUrl
inherited
string

The URL where the item can be downloaded. The resource will be downloaded and stored as a file type. Similar to uploading a file to be added, but instead of transferring the contents of the file, the URL of the data file is referenced and creates a file item.

file
inherited
Blob | File

The file to be uploaded. If uploading a file, the request must be a multipart request.

filename
inherited
string

The filename being uploaded in multipart mode. Required if multipart=true.

folderId
inherited
string

Id of the folder to house the item.

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.

itemIItemUpdate
maxUrlLength
inherited
number

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

multipart
inherited
boolean

If true, the file is uploaded in multiple parts.

overwrite
inherited
boolean

If true, overwrite the existing file.

owner
inherited
string

The owner of the item. If this property is not present, item.owner will be passed, or lastly authentication.getUsername() .

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.

text
inherited
string

The text content for the item to be submitted.

async

optionalinheritedinherited
Interface Property
async: boolean

If true, the file is uploaded asynchronously. If false, the file is uploaded synchronously.

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.

dataUrl

optionalinheritedinherited
Interface Property
dataUrl: string

The URL where the item can be downloaded. The resource will be downloaded and stored as a file type. Similar to uploading a file to be added, but instead of transferring the contents of the file, the URL of the data file is referenced and creates a file item.

file

optionalinheritedinherited
Interface Property
file: Blob | File

The file to be uploaded. If uploading a file, the request must be a multipart request.

filename

optionalinheritedinherited
Interface Property
filename: string

The filename being uploaded in multipart mode. Required if multipart=true.

folderId

optionalinheritedinherited
Interface Property
folderId: string

Id of the folder to house the item.

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.

    item

    Interface Property

    maxUrlLength

    optionalinheritedinherited
    Interface Property
    maxUrlLength: number

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

    multipart

    optionalinheritedinherited
    Interface Property
    multipart: boolean

    If true, the file is uploaded in multiple parts.

    overwrite

    optionalinheritedinherited
    Interface Property
    overwrite: boolean

    If true, overwrite the existing file.

    owner

    optionalinheritedinherited
    Interface Property
    owner: string

    The owner of the item. If this property is not present, item.owner will be passed, or lastly authentication.getUsername() .

    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.

    text

    optionalinheritedinherited
    Interface Property
    text: string

    The text content for the item to be submitted.

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