Copying OneDrive Folders

In this article

    You can copy backed-up OneDrive folders to another location in Microsoft OneDrive.

    Request

    POST https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/folders/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.

    Request Body

    To copy backed-up OneDrive folders to a different production server, the request body must contain the following properties:

    Property

    Type

    Description

    folders

    folder[]

    Accepts IDs of folders that you want to copy. For more information on how to get such IDs, see Getting OneDrive Folders.

    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 the changed 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.

    sendSharedLinksNotification

    boolean

    If set to true, indicates that shared links notifications will be sent.

    documentVersion

    documentVersion

    Specifies, which of the following versions of the OneDrive documents will be copied:

    • all
    • last

    documentLastVersionAction

    documentLastVersionAction

    Specifies, which one of the following actions will be performed with the last version of the copied OneDrive documents on the destination server:

    • overwrite
    • merge

    For example:

    Request Body:

    {

       "userName": "djohnes@northsupport.onmicrosoft.com",

       "userPassword": "paSSw0rd",

       "folders":  [

         {"Id": "74685f6b-16aa-4a78-a44f-05526ce0ae30"},

         {"Id": "70013a9e-c446-429d-aa78-9c8c20d9b814"}

         ]

    }

    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 OneDrive folders.

    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/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,

      "folders" :

      [

          {

       "id": "3dfb16ea-0dd1-43d0-becf-ee47713afb67",

       "name": "Shared with Everyone",

       "createdBy": "administrator",

       "creationTime": "2017-12-06T12:26:46",

       "modifiedBy": "administrator",

       "modificationTime": "2017-12-06T12:26:46",

       "_links": {

        "self": {

         "href": "v6/RestoreSessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/folders/3dfb16ea-0dd1-43d0-becf-ee47713afb67"

        },

        "onedrive": {

         "href": "v6/RestoreSessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39"

        },

        "folders": {

         "href": "v6/RestoreSessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/folders?parentId=3dfb16ea-0dd1-43d0-becf-ee47713afb67"

        },

        "documents": {

         "href": "v6/RestoreSessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/documents?parentId=3dfb16ea-0dd1-43d0-becf-ee47713afb67"

        }

       }

      }

     

      ]

      

    }

     

    Response:

    200 OK