Saving SharePoint Documents

In this article

    You can save a backed-up SharePoint 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.

    Saving SharePoint Documents Tip

    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/{documentId}/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.

    documentId

    string

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

    Request Body

    To save a backed-up SharePoint document, the request body must contain the following property:

    Property

    Type

    Description

    asZip

    boolean

    If set to true, indicates that the SharePoint 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 SharePoint document.

    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/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddd91646d1-5b4a-468f-8d38-7c2eb3cd057248d332e5-c3f9-4373-9902-beac5510d46a/save

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "asZip" : false

    }

     

    Response:

    200 OK