Skip to content

Interface

Apply edits request options. See the REST Documentation for more information.

Inheritance: IApplyEditsOptionsISharedEditOptions

Properties

Hide inherited properties
PropertyTypeNotes
addsIFeature[]

Array of JSON features to add.

attachments{ adds?: IApplyEditsAddAttachmentOptions[]; deletes?: string[]; updates?: IApplyEditsUpdateAttachmentOptions[] }

Use the attachments parameter to add, update or delete attachments. Applies only when the useGlobalIds parameter is set to true. See attachment param details.

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.

credentials
inherited
RequestCredentials

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

deletesnumber[] | string[]

Array of objectIds or globalIds to delete.

gdbVersion
inherited
string

The geodatabase version to apply the edits.

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.

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

boolean

Optional parameter specifying whether the response will report the time features were added.

boolean

Optional parameter to specify if the edits should be applied only if all submitted edits succeed.

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.

trueCurveClientboolean

Optional parameter which is false by default is set by client to indicate to the server that client in true curve capable.

updatesIFeature[]

Array of JSON features to update.

url
inherited
string

Layer service url.

useGlobalIdsboolean

When set to true, the features and attachments in the adds, updates, deletes, and attachments parameters are identified by their globalIds.

adds

optional
Interface Property

attachments

optional
Interface Property

authentication

optionalinherited
Interface Property

credentials

optionalinherited
Interface Property

deletes

optional
Interface Property

gdbVersion

optionalinherited
Interface Property

headers

optionalinherited
Interface Property

hideToken

optionalinherited
Interface Property

httpMethod

optionalinherited
Interface Property

maxUrlLength

optionalinherited
Interface Property

params

optionalinherited
Interface Property

portal

optionalinherited
Interface Property

rawResponse

optionalinherited
Interface Property

returnEditMoment

optionalinherited
Interface Property

rollbackOnFailure

optionalinherited
Interface Property

signal

optionalinherited
Interface Property

suppressWarnings

optionalinherited
Interface Property

trueCurveClient

optional
Interface Property

updates

optional
Interface Property

url

inherited
Interface Property

useGlobalIds

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