IApplyEditsOptions

Interface

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

Inheritance: IApplyEditsOptionsISharedEditOptions

Properties

PropertyTypeNotes
adds
 optional 

Array of JSON features to add.

attachments
 optional 
{ adds?: any[]; deletes?: string[]; updates?: any[] }

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

authentication
 optional 

The instance of ApiKey, ArcGISIdentityManager or ApplicationSession 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
 optional 
RequestCredentials

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

deletes
 optional 
number[] | string[]

Array of objectIds or globalIds to delete.

gdbVersion
 optional 
string

The geodatabase version to apply the edits.

headers
 optional 
{ [key: string]: any }

Additional Headers to pass into the request.

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

The HTTP method to send the request with.

maxUrlLength
 optional 
number

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

params
 optional 

Additional parameters to pass in the request.

portal
 optional 
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 
boolean

Return the raw response

returnEditMoment
 optional 
boolean

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

rollbackOnFailure
 optional 
boolean

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

signal
 optional 
AbortSignal

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

suppressWarnings
 optional 
boolean

Suppress any ArcGIS REST JS related warnings for this request.

trueCurveClient
 optional 
boolean

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

updates
 optional 

Array of JSON features to update.

string

Layer service url.

useGlobalIds
 optional 
boolean

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

adds optional

adds: IFeature[]

Array of JSON features to add.

attachments optional

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

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

authentication optional

authentication: string | IAuthenticationManager

The instance of ApiKey, ArcGISIdentityManager or ApplicationSession 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 optional

credentials: RequestCredentials

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

deletes optional

deletes: number[] | string[]

Array of objectIds or globalIds to delete.

gdbVersion optional

gdbVersion: string

The geodatabase version to apply the edits.

headers optional

headers: { [key: string]: any }

Additional Headers to pass into the request.

hideToken optional

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 optional

httpMethod: HTTPMethods

The HTTP method to send the request with.

maxUrlLength optional

maxUrlLength: number

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

params optional

params: IParams

Additional parameters to pass in the request.

portal optional

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 optional

rawResponse: boolean

Return the raw response

returnEditMoment optional

returnEditMoment: boolean

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

rollbackOnFailure optional

rollbackOnFailure: boolean

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

signal optional

signal: AbortSignal

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

suppressWarnings optional

suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

trueCurveClient optional

trueCurveClient: boolean

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

updates optional

updates: IFeature[]

Array of JSON features to update.

url

url: string

Layer service url.

useGlobalIds optional

useGlobalIds: boolean

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

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