ArcGIS REST JS
ArcGIS REST API JavaScript Client

deleteFeatures

Function 
import { deleteFeatures } from '@esri/arcgis-rest-feature-layer';
//
deleteFeatures({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0",
  objectIds: [1,2,3]
});

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

Parameters

Parameter Type Default Notes
requestOptions Required IDeleteFeaturesOptions

Available requestOptions

Property Type Notes
url Inherited string

Layer service url.
objectIds Optional number[] | number

Array of objectIds to delete.
authentication Optional Inherited IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.
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.
gdbVersion Optional Inherited string

The geodatabase version to apply the edits.
geometry Optional Inherited IGeometry
geometryType Optional Inherited GeometryType
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.
inSR Optional Inherited string | ISpatialReference
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
returnEditMoment Optional Inherited boolean

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

Optional parameter to specify if the edits should be applied only if all submitted edits succeed.
spatialRel Optional Inherited SpatialRelationship
where Optional Inherited string

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

Returns

A Promise that will resolve with the deleteFeatures response.

Promise<{
deleteResults:
IEditFeatureResult[] | IEditFeatureResult
}>
Function defined in packages/arcgis-rest-feature-layer/src/delete.ts:42