Restores a backed up SharePoint list with a specified ID.
Request
To restore a backed up SharePoint list, send the POST HTTPS request to the URL of the /RestoreSessions/{ID}/Organization/Sites/{ID}/Lists/{ID}/Action resource.
HTTPS Request
POST https://<Backup-Office365>:4443/v2/RestoreSessions/{ID}/Organization/Sites/{ID}/Lists/{ID}/Action |
Request Headers
The request header must contain the authorization token for the current logon session.
Request Body
To restore a SharePoint list, the request body must contain the restoreTo action properties:
Property | Type | Description |
UserName | string | Specifies the user name you want to use for authenticating with the organization. For example, "userName": "jsmith@westsupport.onmicrosoft.com". |
UserPassword | string | Specifies the user name you want to use for authenticating with the organization. For example, "userPassword": "paSSw0rd". |
List | string | Specifies the target SharePoint list. |
ChangedItems | bool | If set to True, indicates that the SharePoint list will be restored with all changed items. For example, "changedItems": "true". |
DeletedItems | bool | If set to True, indicates that the SharePoint list will be restored with all deleted items. For example, "deletedItems": "true". |
RestorePermissions | bool | If set to True, indicates that the SharePoint documents will be restored with the backed up permissions. For example, "restorePermissions": "true". |
SendSharedLinksNotification | bool | If set to True, indicates that shared links notifications will be sent. For example, "sendSharedLinksNotification": "true" |
RestoreListViews | bool | If set to True, indicates that the SharePoint lists will be restored with all list views. For example, "restoreListViews": "true". |
DocumentVersion | DocumentVersion | Specifies, which of the following versions of the SharePoint documents will be restored:
|
DocumentLastVersionAction | DocumentLastVersionAction | Specifies, which one of the following actions will be performed with the last version of the restored SharePoint document on the destination list:
|
For example:
{ "restoreTo": {"userName": "jsmith@westsupport.onmicrosoft.com", "userPassword": "paSSw0rd", "list": "support_north", "changedItems": "True", "deletedItems": "True", "restorePermissions": "True", "restoreListviews": "True" "documentVersion": "last", "documentLastVersionAction": "merge" } } |
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 and save actions: application/octet-stream. The media type and syntax of the request body message for the requests with the restore and send actions: null. |
Response Body
None.
Example
The following request restores SharePoint lists
Request: POST https://support.east.local:4443/v2/RestoreSessions/742fe5ac-3ea6-422b-b204-757b15a47e56/Organization/Sites/37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c34444/Lists/37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c34444d0bf1b2f-be66-4982-ba88-a31a49f61a3a/Action
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "restoreTo" : { "List" : "someList", "RestoreListViews" : true, "ChangedItems" : true, "DeletedItems" : true, "username" : "admin", "userpassword" : "password", "RestorePermissions" : true, "DocumentVersion" : "All" } }
Response: 200 OK |
