- URL:https://<notebookserveradmin>/dataaccess/notebookworkspace
- Required Capability:Administrator or Create and Edit ArcGIS Notebooks
- Related Resources:Data Access, Upload File, Download File, Delete File
- Version Introduced:10.9
Description
This operation lists files that are located in the workspace directory (/arcgis/home) of the user making the request. A list of all files and folders is returned in a single response. Files contained in a subfolder are returned in a foldername/filename format.
Request parameters
| Parameter | Details |
|---|---|
| restype (Required) | The default container is the workspace directory of the user. Value: container |
| comp (Required) | Specifies the operation to list all files. Value: list |
| f | The response format. The default response format is xml. Values: html | json | pjson | xml |
Example usage
Below is a sample request URL for the list files operation:
https://notebookserver.domain.com/arcgis/admin/dataaccess/notebookworkspace?restype=container&comp=list&f=htmlJSON Response syntax
{
"Blobs": [
{
"Deleted": false,
"Properties": {
"BlobType": "BlockBlob"
},
"Name": “filename1”
},
{
"Deleted": false,
"Properties": {
"BlobType": "BlockBlob"
},
"Name": “.hiddenfilename1
},
{
"Deleted": false,
"Properties": {
"BlobType": "BlockBlob"
},
"Name": “filename2”
},
{
"Deleted": false,
"Properties": {
"BlobType": "BlockBlob"
},
"Name": “foldername1/filename1”
},
{
"Deleted": false,
"Properties": {
"BlobType": "BlockBlob"
},
"Name": “foldername1/filename2”
},
{
"Deleted": false,
"Properties": {
"BlobType": "BlockBlob"
},
"Name": “foldername2/filename1”
},
{
"Deleted": false,
"Properties": {
"BlobType": "BlockBlob"
},
"Name": “foldername2/filename2”
}
]
}JSON Response example
{
"Blobs": [
{
"Deleted": false,
"Properties": {
"BlobType": "BlockBlob"
},
"Name": ".jupyter_notebook_config.py"
},
{
"Deleted": false,
"Properties": {
"BlobType": "BlockBlob"
},
"Name": "hydrology/mjwater.zip"
},
{
"Deleted": false,
"Properties": {
"BlobType": "BlockBlob"
},
"Name": "mjwater.zip"
},
]
}XML Response example
<EnumerationResults>
<Blobs>
<Blob>
<Deleted>false</Deleted>
<Name>PortlandRelates.gdb.zip</Name>
<Properties>
<BlobType>BlockBlob</BlobType>
</Properties>
</Blob>
<Blob>
<Deleted>false</Deleted>
<Name>顧客リスト.csv</Name>
<Properties>
<BlobType>BlockBlob</BlobType>
</Properties>
</Blob>
<Blob>
<Deleted>false</Deleted>
<Name>part1_prepare_hurricane_data.ipynb</Name>
<Properties>
<BlobType>BlockBlob</BlobType>
</Properties>
</Blob>
</Blobs>
</EnumerationResults>