Move

URL:: https://dataaccess/<workspacename>/notebookworkspace/move
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 move operation enables an administrator or a notebook author to relocate a file or folder within their workspace. Additionally, administrators have the privilege to transfer a file or folder between user workspaces. This action is permitted only when there are no active notebook containers open for the user whose file or folder is being relocated.

Request parameters

Parameter	Details
`source` (Required)	The name of the file or folder to be moved should be specified. To move the file or folder from a specific folder path, prepend the name with a relative path to the `/arcgis/home` folder, as shown in the example below. Example Use dark colors for code blocksCopy `1 source=csv_folder`
`target` (Required)	Desired output name for file or folder. To move the file or folder to a specific folder path, prefix the name with a relative path to `/arcgis/home` folder as shown in example below. Example Use dark colors for code blocksCopy `1 target=mydata/csv_folder`
`targetUsername` (Required)	The `targetUsername` refers to the recipient of the moved file or folder. In cases involving non-administrators, the `targetUsername` must match the user initiating the move operation. Example Use dark colors for code blocksCopy `1 targetUsername=gis_joe`
`f`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

Example usages

The following are example requests for the move operation.

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

targetUsername=gis_joe&source=csv_folder&target=mydata/csv_folder&f=pjson&token=PuuxoDV8HzHD1GxXUDpgHDeItErtl9Wr6rbULdhXHVUnGsjZ2hI1j1cPmnDEN1UnUfDqrNr2AuviTe5OkBumXsPlwSCrKw_ZVM1vczv2ziRESyz2PEAAhfsf71EyKIEGe7wW1z7hN_aLIjTekcdUbs-xtUAMZjEKHDRxT85NlfWqQghOy6o5XE54P8nnmdhllY6IfdtqeRtOYfFLoCBGCmOFV8diNVk4CxW3MMnzelDAGuRpN-Bru-vcYTY-7Or9

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

targetUsername=gis_jane&source=csvdata1/7000Points.csv&target=csvdata/7000Points.csv&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

The sample response below demonstrates a success response returned by the operation:

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

The sample response below demonstreates an error message that is returned when attempting to move files when the user has actively running contianers:

Use dark colors for code blocksCopy
{
  "error": {
    "code": 500,
    "message": "Failed to move user workspace. The user has actively running containers.",
    "details": null
  }
}