List Files

URL:
https://<notebookserveradmin>/dataaccess/<workspacename>/notebookworkspace
Methods:
GET
Required Capability:
Administrator or Create and Edit
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 sub folder are returned in a foldername/filename format.

Request parameters

ParameterDetails

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:

1
https://notebookserver.domain.com/arcgis/admin/dataaccess/notebookworkspace?restype=container&comp=list&f=html

JSON Response syntax

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
{
  "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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
  "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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<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>

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close