Download File

URL:: https://dataacccess/notebookworkspace/downloadFile
Methods:: POST
Required Capability:: Access allowed with the "Create and edit notebooks" privilege
Version Introduced:: 11.5

Description

Attention

Accessing the dataaccess resource, and any of its sub-operations and resources, redirects users to the Notebook Services Admin API Directory. These endpoint are accessible using the following URL pattern:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/notebooks/admin/dataacess/<....>

To return to the Enterprise Admin API directory, users should modify their URLs in the following way:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin

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. Example 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.

Example
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

The following is a sample POST request for the downloadFile operation:

Use dark colors for code blocksCopy
POST /<context>/notebooks/admin/dataaccess/notebookworkspace/downloadFile HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-fprm-urlencoded
Content-Length: []

fileName=hydrology/mjwater.zip&f=pjson&token=PuuxoDV8HzHD1GxXUDpgHDeItErtl9Wr6rbULdhXHVUnGsjZ2hI1j1cPmnDEN1UnUfDqrNr2AuviTe5OkBumXsPlwSCrKw_ZVM1vczv2ziRESyz2PEAAhfsf71EyKIEGe7wW1z7hN_aLIjTekcdUbs-xtUAMZjEKHDRxT85NlfWqQghOy6o5XE54P8nnmdhllY6IfdtqeRtOYfFLoCBGCmOFV8diNVk4CxW3MMnzelDAGuRpN-Bru-vcYTY-7Or9

JSON Response syntax

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

JSON Response example

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