Notebook Workspace

URL:: https://dataaccess/notebookworkspace
Methods:: GET
Operations:: Upload File, Upload File (Blobstore SDK), Download File, Create Folder, Delete File
Version Introduced:: 11.5

Access requirements

Required privileges

The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.

Manage licenses Link to organization-specific group Update Delete Security and infrastructure Servers Organization website Organization webhooks

To access notebook-related endpoints, administrators must be assigned a custom role that includes any of the privileges listed above as well as the Create and edit notebooks privilege.

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.

Learn how to generate a token

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 notebookworkspace resource 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

Parameter Details

Parameter	Details
`restype` (Optional)	The default container is the workspace directory of the user. Value: `container`
`comp` (Optional)	Specifies the operation to list all files. Value: `list`
`f`	The response format. The default response format is `xml`. Values: `html` \| `json` \| `pjson` \| `xml`

restype

(Optional)

The default container is the workspace directory of the user.

Value: container

comp

(Optional)

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

The following is a sample request URL for the list files operation:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/notebooks/admin/dataaccess/notebookworkspace?restype=container&comp=list&f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
  "Blobs": [
    {
      "Deleted": false,
      "Properties": {
        "BlobType": "BlockBlob"
      },
      "Name": "<filename>"
    },
    {
      "Deleted": false,
      "Properties": {
        "BlobType": "BlockBlob"
      },
      "Name": "<.hiddenfilename1>"
    },
    {
      "Deleted": false,
      "Properties": {
        "BlobType": "BlockBlob"
      },
      "Name": "<filename>"
    },
    {
      "Deleted": false,
      "Properties": {
        "BlobType": "BlockBlob"
      },
      "Name": "<foldername/filename>"
    },
    {
      "Deleted": false,
      "Properties": {
        "BlobType": "BlockBlob"
      },
      "Name": "<foldername/filename>"
    },
    {
      "Deleted": false,
      "Properties": {
        "BlobType": "BlockBlob"
      },
      "Name": "<foldername/filename>"
    },
    {
      "Deleted": false,
      "Properties": {
        "BlobType": "BlockBlob"
      },
      "Name": "<foldername/filename>"
    }
  ]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "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

Use dark colors for code blocksCopy
<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>