This is an archive version of the document. To get the most up-to-date information, see the current version.

(POST) /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/{documentId}/Action

In this article

Restores, sends and saves a backed up SharePoint document with a specified ID.

Request

To perform actions with a backed up SharePoint document, send the POST HTTPS request to the URL of the /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/{documentId}/Action resource.

HTTPS Request

POST https://<Backup-Office365>:4443/v3/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/{documentId}/Action

Request Headers

The request header must contain the authorization token for the current logon session.

Request Body

Restore

To restore a SharePoint document, 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.
RestorePermissions	bool	If set to True, indicates that the SharePoint documents will be restored with all permissions. For example, "restorePermissions": "true".
SendSharedLinksNotification	bool	If set to True, indicates that shared links notifications will be sent. For example, "sendSharedLinksNotification": "true"
DocumentVersion	DocumentVersion	Specifies, which of the following versions of the SharePoint documents will be restored: all last
DocumentLastVersionAction	DocumentLastVersionAction	Specifies, which one of the following actions will be performed with the last version of the restored SharePoint document on the destination server: overwrite merge

For example:

{

"restoreTo":

{"userName": "jsmith@westsupport.onmicrosoft.com",

"userPassword": "paSSw0rd",

"list": "listname",

"restorePermissions": "true",

"documentVersion": "last",

"documentLastVersionAction": "overwrite"

}

Send

To send a SharePoint document as attachment in an email message, the request body must contain the sendTo action:

Property	Type	Description
From	string	Specifies the email address from which a document will be sent. For example, "from": "j_smith@bestsupport.onmicrosoft.com".
To	string	Specifies the email address to which a document will be sent. For example, "to": "r.clark@bestsupport.onmicrosoft.com".
Subject	string	Specifies the subject of the email message used for sending a document. For example, "subject": "Support Ticket".
Text	string	Specifies the body of the email message used for sending a document. For example, "text": "Please find attached the files you requested".

For example:

{

"sendTo":

{"from": "j_smith@bestsupport.onmicrosoft.com",

"to": "r.clark@bestsupport.onmicrosoft.com",

"subject": "Support Ticket",

"text": "Please find attached the files you requested"

}

(POST) /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/{documentId}/Action Note:

To be able to send documents as attachments you must specify the VESP email settings by sending PUT HTTPS request to the /VESPEmailSettings URL. For more information, see (PUT) /VESPEmailSettings.

Save

To save a SharePoint document, the request body must contain the save action:

{

"save": null

}

The request command will place the document to a temporary folder on the Veeam Backup for Microsoft Office 365 server. After that, the document will be transferred as application/octet-stream media to the client. To download, read or perform other actions with the octet-stream, use features of programming languages.

(POST) /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/{documentId}/Action Tip:

You can use Swagger UI to download the document from the stream by clicking Download action link in the response body.

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 1

The following request restores a SharePoint document.

Request:

POST https://support.east.local:4443/v3/RestoreSessions/0ba45909-ce2d-4457-9a41-c466c21cd1e3/Organization/Sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/Documents/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddd91646d1-5b4a-468f-8d38-7c2eb3cd057248d332e5-c3f9-4373-9902-beac5510d46a/Action

Request Header:

Authorization: Bearer <Access-Token>

Request Body:

{

"restoreTo" :

{

"list" : "exampleList",

"username" : "admin",

"userpassword" : "password",

"RestorePermissions" : true,

"DocumentVersion" : "last",

"DocumentLastVersionAction" : "Merge"

}

Response:

200 OK

Example 2

The following request saves a SharePoint document.

Request:

Request Header:

Authorization: Bearer <Access-Token>

Request Body:

{

“save” : null

}

Response:

200 OK

Example 3

The following request sends a SharePoint document.

Request:

Request Header:

Authorization: Bearer <Access-Token>

Request Body:

{

"from": "fromUser@example.com",

"to" : "toUser@example.com",

"subject" : "Send document",

"text" : "Hello. It’s your document!"

}

Response:

200 OK