Saving Version of OneDrive Document
You can save a specific version of a backed-up OneDrive document.
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 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/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 OneDrive Items. |
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 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
None.
Example
The following request saves a OneDrive document.
Request: POST https://abc.tech.local:4443/v6/RestoreSessions/61954db6-7278-4d26-86f7-888bda5a4ec4/Organization/OneDrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/Documents/724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11/save
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "asZip" : false }
Response: 200 OK |