- URL:
- https://dataaccess/transferUserWorkspace
- Methods:
POST- Required Capability:
- Access allowed only with the default administrator role
- Version Introduced:
- 11.5
Description
The transfer 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
| Parameter | Details |
|---|---|
(Required) | The username of user whose notebook workspace directory is to be moved. Example |
(Required) | The username of the user who is the recipient of the relocated workspace directory. Example |
(Required) | The directory in the target user's workspace where the files are to be transferred. Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the transfer operation:
POST /<context>/notebooks/admin/dataaccess/transferUserWorkspace HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
userName=gis_joe&targetUserName=gis_jane&targetFoldername=gis_joe_workspace_content&f=pjson&token=PuuxoDV8HzHD1GxXUDpgHDeItErtl9Wr6rbULdhXHVUnGsjZ2hI1j1cPmnDEN1UnUfDqrNr2AuviTe5OkBumXsPlwSCrKw_ZVM1vczv2ziRESyz2PEAAhfsf71EyKIEGe7wW1z7hN_aLIjTekcdUbs-xtUAMZjEKHDRxT85NlfWqQghOy6o5XE54P8nnmdhllY6IfdtqeRtOYfFLoCBGCmOFV8diNVk4CxW3MMnzelDAGuRpN-Bru-vcYTY-7Or9JSON Response syntax
{"status": "<success | failure>"}JSON Response example
The sample response below demonstrates a success response returned by the operation:
{"status":"success"}The sample response below demonstreates an error message that is returned when attempting to transfer the user workspace when the user has actively running contianers:
{
"error": {
"code": 500,
"message": "Failed to transfer user workspace. The user has actively running containers.",
"details": null
}
}