Interface
Apply edits request options. See the REST Documentation for more information.
Properties
Property | Type | Notes |
---|---|---|
IFeature[] | Array of JSON features to add. | |
{ 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. | |
authentication inherited | string | IAuthenticationManager | The instance of |
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 |
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. | |
IFeature[] | 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
adds: IFeature[]
Array of JSON features to add.
attachments
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.
Type declaration
authentication
authentication: 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
credentials: RequestCredentials
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
deletes
deletes: number[] | string[]
Array of objectIds or globalIds to delete.
gdbVersion
gdbVersion: string
The geodatabase version to apply the edits.
headers
headers: { [key: string]: any }
Additional Headers to pass into the request.
Type declaration
- [key: string]: any
hideToken
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
httpMethod: HTTPMethods
The HTTP method to send the request with.
maxUrlLength
maxUrlLength: number
If the length of a GET request's URL exceeds maxUrlLength
the request will use POST instead.
params
params: IParams
Additional parameters to pass in the request.
portal
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'.
returnEditMoment
returnEditMoment: boolean
Optional parameter specifying whether the response will report the time features were added.
rollbackOnFailure
rollbackOnFailure: boolean
Optional parameter to specify if the edits should be applied only if all submitted edits succeed.
signal
signal: AbortSignal
An AbortSignal object instance; allows you to abort a request and via an AbortController.
suppressWarnings
suppressWarnings: boolean
Suppress any ArcGIS REST JS related warnings for this request.
trueCurveClient
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
updates: IFeature[]
Array of JSON features to update.