Sending Version of OneDrive Document

You can send a specific version of a backed-up OneDrive document as an attachment in an email message.

Sending Version of OneDrive Document Note

To be able to send items as attachments, you must specify the Veeam Explorer for Microsoft OneDrive for Business email settings by sending the PUT HTTPS request to the /VEODEmailSettings resource URL. For more information, see Editing Notification Settings.

Request

POST https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Documents/{documentId}/Versions/{versionId}/send

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 OneDrives.

documentId

string

Specifies the identification number of the OneDrive document. For more information on how to get this parameter, see Getting OneDrive Documents.

versionId

integer

Specifies the identification number of the OneDrive document version. For more information on how to get this parameter, see Getting All Versions of OneDrive Document.

Request Body

To send a specific version of a backed-up OneDrive document as an attachment in an email message, the request body must contain the following properties:

Property

Type

Description

skipItemChecks

boolean

If set to true, indicates that Veeam Backup for Microsoft 365 does not check items and skips those items that cannot be sent.

from

string

Specifies the email address from which the attachments will be sent.

to

string

Specifies the email address to which the attachments will be sent.

subject

string

Specifies the subject of the email message used for sending the attachments.

text

string

Specifies the body of the email message used for sending the attachments.

For example:

Request Body:

{

  "skipItemChecks": true,    

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

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

  "subject": "Document",

  "text": "Please, find attached the document you requested"

}

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 example shows how to send a specific version of the specified OneDrive document.

Request:

POST https://abc.tech.local:4443/v6/RestoreSessions/4c49bac1-a871-4413-bc97-ad280a3718cb/Organization/OneDrives/9c4a2afc-5e57-4dfa-a7e2-59e092691772ef4221af-9351-41ec-9128-534cf34db1a5/Documents/dbeb32bf-1ca6-448d-9158-3a19581eb7ab/Versions/3/send

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

  "skipItemChecks": true,    

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

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

  "subject": "Document",

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

}

 

Response:

200 OK