- URL:https://<notebookserveradmin>/dataaccess/notebookworkspace/deleteFile(POST only)
- Required Capability:Administrator or Create and Edit ArcGIS Notebooks
- Version Introduced:10.9
Description
The Delete File operation allows a user to permanently remove a file from their notebook workspace directory (/arcgis/home). Only the owner of the file is allowed to perform this operation.
Request parameters
| Parameter | Details |
|---|---|
| fileName (Required) | The name of the file to be deleted. Example 1: Delete a file from the root directory in the user's workspace. fileName=mjwaterzip Example 2: Delete a file from a subdirectory (/arcgis/home/hydrology) in the user's workspace. fileName=hydrology/mjwaterzip Example 3: Delete a file from a nested subdirectory (/arcgis/home/hydrology/2020) in the user's workspace. fileName=hydrology/2020/mjwaterzip |
| f (Optional) | The response format. The default response format is html. Values: html | json | pjson |
Example 1: Delete a file in a folder
https://notebookserver.domain.com/context/admin/dataaccess/notebookworkspace/deleteFile
fileName = hydrology/mjwater.zip
f = jsonJSON Response syntax
{"status":"success|failure"}
JSON Response example
{"status":"success"}