Copying OneDrive Folders
You can copy a backed-up OneDrive folder with the specified ID to another location in Microsoft OneDrive.
Request
POST https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/folders/{folderId}/copyTo |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
restoreSessionId | string | Specifies the identification number of the restore session. For more information on how to get this parameter, see Getting Restore Sessions. |
oneDriveId | string | Specifies the identification number of OneDrive. For more information on how to get this parameter, see Getting OneDrive Items. |
folderId | string | Specifies the identification number of the OneDrive folder. For more information on how to get this parameter, see Getting OneDrive Folders. |
Request Body
To copy a backed-up OneDrive folder to a different production server, the request body must contain the following properties:
Property | Type | Description |
|---|---|---|
userName | string | Specifies the user name that you want to use for authenticating to the organization. |
userPassword | string | Specifies the password of the user account that you want to use for authenticating to the organization. |
oneDrive | oneDrive | Specifies the target OneDrive copy destination. |
folder | folder | Specifies the target OneDrive folder copy destination. |
changedItems | boolean | If set to true, indicates that all versions of OneDrive items will be copied. |
deletedItems | boolean | If set to true, indicates that deleted OneDrive items will be copied. |
restorePermissions | boolean | If set to true, indicates that the OneDrive items will be copied with all permissions. |
documentVersion | documentVersion | Specifies, which of the following versions of the OneDrive document will be copied:
|
documentLastVersionAction | documentLastVersionAction | Specifies, which one of the following actions will be performed with the last version of the copied OneDrive document on the destination server:
|
For example:
Request Body: { "userName": "djohnes@northsupport.onmicrosoft.com", "userPassword": "paSSw0rd" } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message for the requests with the export and save actions: application/octet-stream. The media type and syntax of the response body message for the requests with the restore and send actions: null. |
Response Body
None.
Example
The following request copies a OneDrive folder.
Request: POST https://abc.tech.local:4443/v6/RestoreSessions/61954db6-7278-4d26-86f7-888bda5a4ec4/Organization/OneDrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/folders/3dfb16ea-0dd1-43d0-becf-ee47713afb67/copyTo
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "userName" : "admin", "userPassword" : "12345678", "documentVersion" : "all", "folder" : "pictures", "oneDrive" : { "id": "724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11", "name": "CopyTo User", "url": "http://server/personal/orgUser", "_links": { "self": { "href": "v6/organizations/a602e179-a821-4544-b653-f4aa03b39817/users/00000000-0000-0000-0000-000000000000d6d5c441-6c14-411a-9147-53f31a16d225AQUAAAAAAAUVAAAApgPzBIixQ2kafNW0dAQAAA==/onedrives/724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11" }, "user": { "href": "v6/organizations/a602e179-a821-4544-b653-f4aa03b39817/users/00000000-0000-0000-0000-000000000000d6d5c441-6c14-411a-9147-53f31a16d225AQUAAAAAAAUVAAAApgPzBIixQ2kafNW0dAQAAA==" } } }, "changedItems" : true, "deletedItems" : true, "restorePermissions" : true }
Response: 200 OK |