Saving SharePoint Documents
You can save backed-up SharePoint documents.
SharePoint documents are always saved in a ZIP archive. When you save documents, the request command archives the documents and places the ZIP archive to a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the archive is 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.
|
You can use Swagger UI to download the document from the stream by clicking the Download action link in the response body. For more information, see Evaluation in Swagger UI. |
Request
POST https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/save |
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 save backed-up SharePoint documents, the request body must contain the following property:
Property | Type | Description |
|---|---|---|
documents | document[] | Accepts IDs of documents that you want to save. For more information on how to get such IDs, see Getting SharePoint Documents. |
For example:
Request Body: { "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 following request saves 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/save
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "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: 200 OK |