Sending and Saving SharePoint Attachments

In this article

    You can send and save a collection of backed-up SharePoint item attachments.

    Request

    POST https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Items/{itemId}/Attachments/action

    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.

    itemId

    string

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

    Request Body

    Send

    To send SharePoint item attachments in an email message, the request body must contain the sendTo action properties:

    Property

    Type

    Description

    attachments

    attachment[]

    Accepts IDs of SharePoint item attachments that you want to send in an email message. For more information on how to get such IDs, see Getting SharePoint Attachments.

    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:

    {

     "sendTo":

     {

      "from": "j_smith@bestsupport.onmicrosoft.com",

      "to": "r.clark@bestsupport.onmicrosoft.com",

      "subject": "Support Ticket",

      "text": "Please, find attached the files you requested",

      "attachments":  [

       {"Id": "ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd0801b635-c19c-4435-a7c2-2fe46112bd3cd235bb5f-7aa8-4833-8f1b-b6dc1f22f13cd6b2e9b7-e37e-48fb-92fc-4dfb7721b59f"},

       {"Id": "ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd0801b635-c19c-4435-a7c2-2fe46112bd3cd235bb5f-7aa8-4833-8f1b-b6dc1f22f13cd6b2e9b7-e37e-48fb-92fc-4dfb7801b59c"}

       ]

     }

    }

     

    Sending and Saving SharePoint Attachments Note

    To be able to send item attachments you must specify the Veeam Explorer for Microsoft SharePoint email settings by sending PUT HTTPS request to the /VESPEmailSettings URL. For more information, see (PUT) /VESPEmailSettings.

    Save

    Sending and Saving SharePoint Attachments Note

    SharePoint item attachments are always saved in a ZIP archive.

    To save SharePoint item attachments, the request body must contain the save action property:

    Property

    Type

    Description

    attachments

    attachment[]

    Accepts IDs of SharePoint item attachments that you want to save. For more information on how to get such IDs, see Getting SharePoint Attachments.

    For example:

    Request Body:

    {

    "save":

     {

      "attachments":  [

         {"Id": "ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd0801b635-c19c-4435-a7c2-2fe46112bd3cd235bb5f-7aa8-4833-8f1b-b6dc1f22f13cd6b2e9b7-e37e-48fb-92fc-4dfb7721b59f"},

       {"Id": "ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd0801b635-c19c-4435-a7c2-2fe46112bd3cd235bb5f-7aa8-4833-8f1b-b6dc1f22f13cd6b2e9b7-e37e-48fb-92fc-4dfb7801b59c"}

         ]

     }

    }

    The request command will archive the item attachments and place the ZIP archive to a temporary folder on the Veeam Backup for Microsoft Office 365 server. After that, the archive will be 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.

    Sending and Saving SharePoint Attachments Tip

    You can use Swagger UI to download the document from the stream by clicking Download action link in the response body. For more information, see Evaluation in Swagger UI.

    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.

    Examples

    Example 1

    The following request saves SharePoint item attachments.

    Request:

    POST https://abc.tech.local:4443/v5/RestoreSessions/742fe5ac-3ea6-422b-b204-757b15a47e56/Organization/Sites/ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd/Items/ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd0801b635-c19c-4435-a7c2-2fe46112bd3cd235bb5f-7aa8-4833-8f1b-b6dc1f22f13c/Attachments/action

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "save" :

     {

      "attachments" :

      [

       {

       "id": "ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd0801b635-c19c-4435-a7c2-2fe46112bd3cd235bb5f-7aa8-4833-8f1b-b6dc1f22f13cd6b2e9b7-e37e-48fb-92fc-4dfb7721b59f",

       "name": "ItemAttachment01.txt",

       "sizeBytes": 16,

       "url": "/sites/integration/Lists/myalias/Attachments/11/ItemAttachment01.txt",

       "_links": {

        "self": {

         "href": "https://support.north.local:4443/v5/RestoreSessions/742fe5ac-3ea6-422b-b204-757b15a47e56/organization/sites/ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd/items/ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd0801b635-c19c-4435-a7c2-2fe46112bd3cd235bb5f-7aa8-4833-8f1b-b6dc1f22f13c/attachments/ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd0801b635-c19c-4435-a7c2-2fe46112bd3cd235bb5f-7aa8-4833-8f1b-b6dc1f22f13cd6b2e9b7-e37e-48fb-92fc-4dfb7721b59f"

        },

        "item": {

         "href": "https://support.north.local:4443/v5/RestoreSessions/742fe5ac-3ea6-422b-b204-757b15a47e56/organization/sites/ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd/items/ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd0801b635-c19c-4435-a7c2-2fe46112bd3cd235bb5f-7aa8-4833-8f1b-b6dc1f22f13c"

        }

       }

      }

      ]

     }

    }

     

    Response:

    200 OK

    Example 2

    The following request sends SharePoint item attachments in an email message.

    Request:

    POST https://abc.tech.local:4443/v5/RestoreSessions/742fe5ac-3ea6-422b-b204-757b15a47e56/Organization/Sites/ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd/Items/ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd0801b635-c19c-4435-a7c2-2fe46112bd3cd235bb5f-7aa8-4833-8f1b-b6dc1f22f13c/Attachments/action

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "sendTo" :

     {

      "attachments" :

      [

       {

       "id": "ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd0801b635-c19c-4435-a7c2-2fe46112bd3cd235bb5f-7aa8-4833-8f1b-b6dc1f22f13cd6b2e9b7-e37e-48fb-92fc-4dfb7721b59f",

       "name": "ItemAttachment01.txt",

       "sizeBytes": 16,

       "url": "/sites/integration/Lists/myalias/Attachments/11/ItemAttachment01.txt",

       "_links": {

        "self": {

         "href": "https://support.north.local:4443/v5/RestoreSessions/742fe5ac-3ea6-422b-b204-757b15a47e56/organization/sites/ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd/items/ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd0801b635-c19c-4435-a7c2-2fe46112bd3cd235bb5f-7aa8-4833-8f1b-b6dc1f22f13c/attachments/ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd0801b635-c19c-4435-a7c2-2fe46112bd3cd235bb5f-7aa8-4833-8f1b-b6dc1f22f13cd6b2e9b7-e37e-48fb-92fc-4dfb7721b59f"

        },

        "item": {

         "href": "https://support.north.local:4443/v5/RestoreSessions/742fe5ac-3ea6-422b-b204-757b15a47e56/organization/sites/ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd/items/ef10cefb-d29a-4dac-827a-d3702fc4ac8f6d7caa6b-bad0-4e67-9736-8bf5b0b55ebd0801b635-c19c-4435-a7c2-2fe46112bd3cd235bb5f-7aa8-4833-8f1b-b6dc1f22f13c"

        }

       }

      }

      ]

      "from": "fromUser@example.com",

      "to" : "toUser@example.com",

      "subject" : "Send document",

      "text" : "Hello. It’s your document!"

     

     }

    }

     

    Response:

    200 OK