Saving Version of OneDrive Document
You can save a specific version of a backed-up OneDrive document with the specified ID.
When you save a document, the request command places the document to a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the document 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 data 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/OneDrives/{oneDriveId}/Documents/{documentId}/Versions/{versionId}/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. |
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 save a specific version of a backed-up OneDrive document, the request body must contain the following property:
Property | Type | Description |
|---|---|---|
asZip | boolean | If set to true, indicates that the OneDrive document will be saved in a ZIP archive. Example: "asZip": true. |
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
In the response body, the server returns binary data stream.
Example
The example shows how to save 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/save
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "asZip" : false }
Response: 200 OK |