Sends and saves a backed up SharePoint item attachment with a specified ID.
Request
To perform actions with a backed up SharePoint item attachment, send the POST HTTPS request to the URL of the /RestoreSessions/{ID}/Organization/Sites/{ID}/Items/{ID}/Attachments/{ID}/Action resource.
HTTPS Request
POST https://<Backup-Office365>:4443/v2/RestoreSessions/{ID}/Organization/Sites/{ID}/Items/{ID}/Attachments/{ID}/Action |
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
Content-Type: application/json | true | Specifies the type of the content for your request. |
Authorization: Bearer <Access-Token> | true | The request header must contain the authorization token for the current logon session. |
Request Body
Send
To send a SharePoint item attachment in an email message, the request body must contain the sendTo action properties:
Property | Type | Description |
From | string | Specifies the email address from which the attachment will be sent. For example, "from": "j_smith@bestsupport.onmicrosoft.com". |
To | string | Specifies the email address to which the attachment will be sent. For example, "to": "r.clark@bestsupport.onmicrosoft.com". |
Subject | string | Specifies the subject of the email message used for sending the attachment. For example, "subject": "Support Ticket". |
Text | string | Specifies the body of the email message used for sending the attachment. For example, "text": "Please find attached the files you requested". |
For example:
{ "sendTo": {"from": "j_smith@bestsupport.onmicrosoft.com", "to": "r.clark@bestsupport.onmicrosoft.com", "subject": "Support Ticket", "text": "Please find attached the files you requested" } } |
|
To be able to send an item attachment you must specify the VESP email settings by sending PUT HTTPS request to the /VESPEmailSettings URL. For more information, see (PUT) /VESPEmailSettings. |
Save
To save a SharePoint item attachment, the request body must contain the save action:
{ "save": null } |
The request command will place the item attachment to a temporary folder on the Veeam Backup for Microsoft Office 365 server. After that, the attachment 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.
|
You can use Swagger UI to download the attachment from the stream by clicking Download action link in the response body. |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns 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 request body message for the requests with the export and save actions: application/octet-stream. The media type and syntax of the request body message for the requests with the restore and send actions: null. |
Response Body
None.
Example 1
The following request saves a SharePoint item attachment.
Request: POST https://support.east.local:4443/v2/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/Action
Request Header: Content-Type: application/json Authorization: Bearer <Access-Token>
Request Body: { "save": null } Response: 200 OK |
Example 2
The following request sends a SharePoint item attachment.
Request: POST https://support.east.local:4443/v2/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/Action
Request Header: Content-Type: application/json Authorization: Bearer <Access-Token>
Request Body: { "sendto" : { "from": "fromUser@example.com", "to" : "toUser@example.com", "subject" : "Send document", "text" : "Hello. It’s your document!"
} }
Response: 200 OK |
