Download File

URL:: https://<notebookserveradmin>/dataaccess/notebookworkspace/downloadFile
Methods:: GET
Related Resources:: Data Access, List Files, Upload File, Delete File
Required Capability:: Administrator or Create and Edit
Version Introduced:: 10.9

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

Parameter Details

Parameter	Details
`fileName` (Required)	The name of the file to be downloaded. Examples Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 //Download a file from the root directory in the user's workspace. fileName=mjwaterzip //Download a file from a subdirectory () in the user's workspace fileName=hydrology/mjwaterzip //Download a file from a nested subdirectory () in the user's workspace fileName=hydrology/2020/mjwaterzip`
`f`	The response format. The default response format is `html` . Values: `html` \| `json` \| `pjson`

fileName

(Required)

The name of the file to be downloaded.

Examples

Use dark colors for code blocksCopy
//Download a file from the root directory in the user's workspace.
fileName=mjwaterzip

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

//Download a file from a nested subdirectory () 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

Use dark colors for code blocksCopy
https://notebookserver.domain.com/context/admin/dataaccess/notebookworkspace/downloadFile
fileName=hydrology/mjwater.zip
f=json

JSON Response syntax

Use dark colors for code blocksCopy
{
  "status": "<success|failure>"
}

JSON Response example

Use dark colors for code blocksCopy
{
  "status": "success"
}