Performs bulk restore of the backed up OneDrive items.
Request
To perform a bulk restore of the backed up OneDrive items, send the POST HTTPS request to the URL of the /RestoreSessions/{ID}/Organization/OneDrives/Action resource.
HTTPS Request
POST https://<Backup-Office365>:4443/v2/RestoreSessions/{ID}/Organization/OneDrives/Action |
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
Content-Type: application/json | true | Specifies the type of the content for your request. |
Authorization: Bearer <Access-Token> | true | The request header must contain the authorization token for the current logon session. |
Request Body
To perform a bulk restore of the backed up OneDrive items, the request body must contain properties:
Property | Type | Description |
OfficeUsername | string | Specifies the user name you want to use for authenticating with the Office 365 organization. For example, "officeUserame": "jsmith@westsupport.onmicrosoft.com". |
OfficePassword | string | Specifies the user password you want to use for authenticating with the Office 365 organization. For example, "officePassword": "paSSw0rd". |
OnPremisesUsername | string | Specifies the user name you want to use for authenticating with the On-Premises organization. For example, "onpremisesUsername": "jsmith@westsupport.onmicrosoft.com". |
OnPremisesPassword | string | Specifies the user password you want to use for authenticating with the On-Premises organization. For example, "onpremisesPassword": "paSSw0rd". |
SkipUnresolved | bool | If set to True, indicates that the restore will skip the unresolved items. For example, "skipUnresolved": "true". |
OneDrives | oneDrive | Specifies the OneDrive items that will be restored. |
DocumentVersion | DocumentVersion | Specifies, which of the following versions of the OneDrive document will be restored:
|
DocumentAction | DocumentAction | Specifies, which one of the following actions will be performed in case the restore destination contains the restored document:
|
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns 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 request body message for the requests with the export action: application/octet-stream. The media type and syntax of the request body message for the requests with the restore actions: null. |
Response Body
None.
Example 1
The following request exports backed up organization's mailbox data containing "support" keyword to a PST file.
Request: POST https://<Backup-Office365>:4443/v2/RestoreSessions/{ID}/Organization/OneDrives/Action
Request Header: Content-Type: application/json Authorization: Bearer <Access-Token>
Request Body: { "restoreToOriginalLocation" : { "DocumentAction" : "keep", "skipunresolved" : true, "OneDrives" : [ { "id": "b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39", "name": "Administrator", "url": "http://server/personal/orgUser", "_links": { "self": { "href": "https://support.north.local:4443/v2/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39" }, "folders": { "href": "https://support.north.local:4443/v2/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/folders?parentId=null" }, "allfolders": { "href": "https://support.north.local:4443/v2/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/folders" }, "documents": { "href": "https://support.north.local:4443/v2/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/documents?parentId=null" }, "alldocuments": { "href": "https://support.north.local:4443/v2/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/documents" } } }, { "id": "724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11", "name": "CopyTo User", "url": "http://server/personal/orgUser", "_links": { "self": { "href": "https://support.north.local:4443/v2/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11" }, "folders": { "href": "https://support.north.local:4443/v2/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11/folders?parentId=null" }, "allfolders": { "href": "https://support.north.local:4443/v2/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11/folders" }, "documents": { "href": "https://support.north.local:4443/v2/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11/documents?parentId=null" }, "alldocuments": { "href": "https://support.north.local:4443/v2/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11/documents" } } } ], "OnPremisesUsername" : "admin", "OnPremisesPassword" : "12345678", "DocumentVersion" : "last" } }
Response: 200 OK |
