IApplyEditsOptions

Interface

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

Inheritance: IApplyEditsOptionsISharedEditOptions

Properties

Hide inherited properties
PropertyTypeNotes

Array of JSON features to add.

{ 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
 inherited 

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
 inherited 
RequestCredentials

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

number[] | 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 

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 

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

returnEditMoment
 inherited 
boolean

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

rollbackOnFailure
 inherited 
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.

suppressWarnings
 inherited 
boolean

Suppress any ArcGIS REST JS related warnings for this request.

boolean

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

Array of JSON features to update.

url
 inherited 
string

Layer service url.

boolean

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
adds: IFeature[]

Array of JSON features to add.

attachments

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

Type declaration

    authentication

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

    optionalinherited
    Interface Property
    credentials: RequestCredentials

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

    deletes

    optional
    Interface Property
    deletes: number[] | string[]

    Array of objectIds or globalIds to delete.

    gdbVersion

    optionalinherited
    Interface Property
    gdbVersion: string

    The geodatabase version to apply the edits.

    headers

    optionalinherited
    Interface Property
    headers: { [key: string]: any }

    Additional Headers to pass into the request.

    Type declaration
    • [key: string]: any

    hideToken

    optionalinherited
    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

    optionalinherited
    Interface Property
    httpMethod: HTTPMethods

    The HTTP method to send the request with.

    maxUrlLength

    optionalinherited
    Interface Property
    maxUrlLength: number

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

    params

    optionalinherited
    Interface Property
    params: IParams

    Additional parameters to pass in the request.

    portal

    optionalinherited
    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

    optionalinherited
    Interface Property
    rawResponse: boolean

    Return the raw response

    returnEditMoment

    optionalinherited
    Interface Property
    returnEditMoment: boolean

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

    rollbackOnFailure

    optionalinherited
    Interface Property
    rollbackOnFailure: boolean

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

    signal

    optionalinherited
    Interface Property
    signal: AbortSignal

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

    suppressWarnings

    optionalinherited
    Interface Property
    suppressWarnings: boolean

    Suppress any ArcGIS REST JS related warnings for this request.

    trueCurveClient

    optional
    Interface Property
    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
    Interface Property
    updates: IFeature[]

    Array of JSON features to update.

    url

    inherited
    Interface Property
    url: string

    Layer service url.

    Inherited from ISharedEditOptions.url

    useGlobalIds

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