This documentation is for ArcGIS REST JS 3.x which is no longer maintained. For the latest 4.x documentation see ArcGIS REST JS on the ArcGIS Developer website.

ICreateUpdateItemOptions

Interface

Extends

Properties

Property Type Notes
authentication Inherited UserSession

A session representing a logged in user.

async Optional boolean

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

dataUrl Optional 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 Optional any

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

filename Optional string

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

folderId Optional string

Id of the folder to house the item.

multipart Optional boolean

If true, the file is uploaded in multiple parts.

overwrite Optional boolean

If true, overwrite the existing file.

owner Optional string

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

text Optional string

The text content for the item to be submitted.

credentials Optional Inherited RequestCredentials

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

fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.

headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.

hideToken Optional 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 Optional Inherited HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional Inherited number

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

params Optional Inherited IParams

Additional parameters to pass in the request.

portal Optional 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 Optional Inherited boolean

Return the raw response


Interface defined in packages/arcgis-rest-portal/src/items/helpers.ts:139