Skip to content

Interface

Delete features request options. See the REST Documentation for more information.

Inheritance: IDeleteFeaturesOptionsISharedEditOptionsISharedQueryOptions

Properties

Hide inherited properties
PropertyTypeNotes
string | 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.

gdbVersion
inherited
string

The geodatabase version to apply the edits.

geometry
inherited
IGeometry
geometryType
inherited
GeometryType
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.

inSR
inherited
string | ISpatialReference
maxUrlLength
inherited
number

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

objectIdsnumber[]

Array of objectIds to delete.

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

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.

spatialRel
inherited
SpatialRelationship
boolean

Suppress any ArcGIS REST JS related warnings for this request.

url
inherited
string

Layer service url.

where
inherited
string

A where clause for the query. Defaults to "1=1"

authentication

optionalinheritedinherited
Interface Property
authentication: string | 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.

gdbVersion

optionalinheritedinherited
Interface Property
gdbVersion: string

The geodatabase version to apply the edits.

geometry

optionalinheritedinherited
Interface Property
geometry: IGeometry

geometryType

optionalinheritedinherited
Interface Property

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.

    inSR

    optionalinheritedinherited
    Interface Property
    inSR: string | ISpatialReference

    maxUrlLength

    optionalinheritedinherited
    Interface Property
    maxUrlLength: number

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

    objectIds

    Interface Property
    objectIds: number[]

    Array of objectIds to delete.

    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

    returnEditMoment

    optionalinheritedinherited
    Interface Property
    returnEditMoment: boolean

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

    rollbackOnFailure

    optionalinheritedinherited
    Interface Property
    rollbackOnFailure: boolean

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

    signal

    optionalinheritedinherited
    Interface Property
    signal: AbortSignal

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

    spatialRel

    optionalinheritedinherited
    Interface Property

    suppressWarnings

    optionalinheritedinherited
    Interface Property
    suppressWarnings: boolean

    Suppress any ArcGIS REST JS related warnings for this request.

    url

    inheritedinherited
    Interface Property
    url: string

    Layer service url.

    Inherited from ISharedEditOptions.url

    where

    optionalinheritedinherited
    Interface Property
    where: string

    A where clause for the query. Defaults to "1=1"

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