Sending SharePoint Documents
You can send backed-up SharePoint documents as attachments in an email message.
|
To be able to send documents as attachments, you must specify the Veeam Explorer for Microsoft SharePoint email settings by sending the PUT HTTPS request to the /VESPEmailSettings resource URL. For more information, see Editing Notification Settings. |
Request
POST https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/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. |
siteId | string | Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Getting Organization SharePoint Sites. |
Request Body
To send backed-up SharePoint documents as attachments 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. |
documents | document[] | Specifies the IDs of documents that you want to send as email attachments. For more information on how to get such IDs, see Getting SharePoint Documents. |
from | string | Specifies the email address from which documents will be sent. |
to | string | Specifies the email address to which documents will be sent. |
subject | string | Specifies the subject of the email message used for sending documents. |
text | string | Specifies the body of the email message used for sending documents. |
For example:
Request Body: { "skipItemChecks": true, "from": "j.smith@bestsupport.onmicrosoft.com", "to": "r.clark@bestsupport.onmicrosoft.com", "subject": "Support Ticket", "text": "Please, find attached the files you requested" "documents": [ {"id": "1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd489d7343-c24d-46f5-978f-0ad62fe4c8703231e17c-2086-4e60-b610-8c5a1871068c"}, {"id": "1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd489d7343-c24d-46f5-978f-0ad62fe4c8704127ac39-dc97-44e2-b5bc-f141f8d0108b"} ] } |
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 SharePoint documents.
Request: POST https://abc.tech.local:4443/v6/RestoreSessions/0ba45909-ce2d-4457-9a41-c466c21cd1e3/Organization/Sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/Documents/send
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "skipItemChecks": true, "documents" : [ { "version": "2.0", "id": "1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddd91646d1-5b4a-468f-8d38-7c2eb3cd057248d332e5-c3f9-4373-9902-beac5510d46a", "name": "request.txt", "createdBy": "System Account", "creationTime": "2021-04-16T12:35:18", "modifiedBy": "System Account", "modificationTime": "2021-04-16T12:37:10", "_links": { "self": { "href": "/v6/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" }, "library": { "href": "/v6/RestoreSessions/0ba45909-ce2d-4457-9a41-c466c21cd1e3/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/libraries/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddd91646d1-5b4a-468f-8d38-7c2eb3cd0572" } } } ], "from": "j.smith@bestsupport.onmicrosoft.com", "to": "r.clark@bestsupport.onmicrosoft.com", "subject": "Support Ticket", "text": "Please, find attached the files you requested" }
Response: 200 OK |