Transfer User Workspace

URL:
https://<root>/dataaccess/<workspacename>/transferUserWorkspace
Methods:
POST
Required Capability:
Administrator
Version Introduced:
11.4

Description

The transferUserWorkspace operation allows an administrator to transfer a user's workspace directory to either another user's workspace directory or their own. It is permissible only when there are no active notebook containers open for the user whose workspace is being transferred.

Request parameters

ParameterDetails

userName

The username of user whose notebook workspace directory is to be moved.

targetUserName

The username of the user who is the recipient of the relocated workspace directory.

targetFolderName

The directory in the target user's workspace where the files are to be transferred.

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

Below is a sample request URL and parameters for the transferUserWorkspace operation:

1
2
3
4
5
6
HTTP POST
https://notebookserver.domain.com/arcgis/admin/dataaccess/transferUserWorkspace
userName=gis_joe
transferUserName = gis_jane
transferFoldername = gis_joe_workspace_content
f=json

JSON Response syntax

1
{"status": "<success | failure>"}

JSON Response example

Example 1:

1
{"status":"success"}

Example 2: Error when source user has one or more active containers

1
2
3
4
5
6
7
{
    "error": {
        "code": 500,
        "message": "Failed to transfer user workspace. The user has actively running containers.",
        "details": null
    }
}

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