Skip To Content
ArcGIS Developer
Dashboard

Download File

Description

The downloadFile operation allows a user to download a file from their notebook workspace directory (/arcgis/home). Only the owner of the file is allowed to download the file.

Request parameters

ParameterDetails
fileName

(Required)

The name of the file to be downloaded.

Examples

//Download a file from the root directory in the user's workspace.
fileName=mjwaterzip

//Download a file from a subdirectory (/arcgis/home/hydrology) in the user's workspace
fileName=hydrology/mjwaterzip

//Download a file from a nested subdirectory (/arcgis/home/hydrology/2020) in the user's workspace
fileName=hydrology/2020/mjwaterzip
f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

https://notebookserver.domain.com/context/admin/dataaccess/notebookworkspace/downloadFile
fileName=hydrology/mjwater.zip
f=json

JSON Response syntax

{
  "status": "<success|failure>"
}

JSON Response example

{
  "status": "success"
}