Sending OneDrive Documents

In this article

    You can send backed-up OneDrive documents as attachments in an email message.

    Sending OneDrive Documents Note

    To be able to send items as attachments, you must specify the Veeam Explorer for Microsoft OneDrive for Business email settings by sending the PUT HTTPS request to the /VEODEmailSettings resource URL. For more information, see Editing Notification Settings.

    Request

    POST https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/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.

    oneDriveId

    string

    Specifies the identification number of OneDrive. For more information on how to get this parameter, see Getting OneDrives.

    Request Body

    To send backed-up OneDrive documents as attachments in an email message, the request body must contain the following properties:

    Property

    Type

    Description

    documents

    document[]

    Specifies the IDs of OneDrive documents that you want to send. For more information on how to get such IDs, see Getting OneDrive Documents.

    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.

    from

    string

    Specifies the email address from which the attachments will be sent.

    to

    string

    Specifies the email address to which the attachments will be sent.

    subject

    string

    Specifies the subject of the email message used for sending the attachments.

    text

    string

    Specifies the body of the email message used for sending the attachments.

    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": "74685f6b-16aa-4a78-a44f-05526ce0ae30"},

         {"id": "70013a9e-c446-429d-aa78-9c8c20d9b814"}

         ]

    }

    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 OneDrive documents.

    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/send

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

      "documents" :

      [

       {

       "id": "0e4079a2-faa5-41bf-b8a7-ba883308cbc9"

       },

       {

       "id": "206b13cc-a453-4102-a256-20a64f760e6d"

       }

      ],

      "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"

    }

     

    Response:

    200 OK