Veeam Backup for Microsoft Office 365 4.0
RESTful API Reference
Related documents

Searching Items by Restore Session, Mailbox and Folder ID

This section explains how to search items in the specified folder.

Request

POST https://<hostname>:4443/v4/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/folders/{folderId}/action

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

Property

Type

Description

restoreSessionId

string

Sets the identification number of the restore session. Can be obtained as described in Getting Restore Sessions

mailboxId

string

Sets the identification number of the mailbox. Can be obtained as described in Getting Mailboxes.

folderId

string

Sets the identification number of the folder. Can be obtained as described in Getting Mailbox Folders.

Request Body

Property

Type

Description

from

string

Sets the name of the sender.

to

string

Sets the name of the recipient.

Request Example

Request:

POST https://<hostname>:4443/v4/RestoreSessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/Organization/Mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/Folders/AAAAAPI-ZgUzFo1OutsrlqscF3YBAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAA/action

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

  "search":{

     "query": "from: user_X to: user_Y"

  }

}

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: application/json; charset=utf-8

Response Body

Property

Type

Description

offset

integer

Shows the offset value.

limit

integer

Shows the offset limit.

results

Results Object

Contains the Results object.

Results Object

Property

Type

Description

from

string

Shows the sender.

cc

string

Shows the recipients of the copy.

bcc

string

Shows the recipients of the concealed copy.

to

string

Shows the recipients.

sent

string

Shows the date and time when the message was sent.

received

string

Shows the date and time when the message was received.

reminder

boolean

Shows if the remainder is set.

subject

string

Sown the subject.

itemClass

string

Shows the item class.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Response Example

Response:

200 OK

 

Response Body:

{

  "offset": 0,

  "limit": 30,

  "results": [   {

     "from": "John Doe in Teams",

     "cc": "",

     "bcc": "",

     "to": "Jane Doe",

     "sent": "2019-10-08T15:13:16Z",

     "received": "2019-10-08T15:13:21.7138592Z",

     "reminder": false,

     "subject": "John Doe",

     "itemClass": "IPM.Note",

     "_links":       {

        "self": {"href": "https://delta.tech.local:4443/v4/restoresessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/items/AAAAAPI-ZgUzFo1OutsrlqscF3YHAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAPoX1QVx9BZHraHZM4xpWtgAARuSD4wAAA"},

        "parent": {"href": "https://delta.tech.local:4443/v4/restoresessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/folders/AAAAAPI-ZgUzFo1OutsrlqscF3YBAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAA"},

        "mailbox": {"href": "https://delta.tech.local:4443/v4/restoresessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d"}

     },

     "_actions":       {

        "restoreToOriginalLocation":          {

           "uri": "https://delta.tech.local:4443/v4/restoresessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/items/AAAAAPI-ZgUzFo1OutsrlqscF3YHAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAPoX1QVx9BZHraHZM4xpWtgAARuSD4wAAA/action",

           "method": "POST"

        },

        "restoreTo":          {

           "uri": "https://delta.tech.local:4443/v4/restoresessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/items/AAAAAPI-ZgUzFo1OutsrlqscF3YHAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAPoX1QVx9BZHraHZM4xpWtgAARuSD4wAAA/action",

           "method": "POST"

        },

        "exportToPst":          {

           "uri": "https://delta.tech.local:4443/v4/restoresessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/items/AAAAAPI-ZgUzFo1OutsrlqscF3YHAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAPoX1QVx9BZHraHZM4xpWtgAARuSD4wAAA/action",

           "method": "POST"

        },

        "saveToMsg":          {

           "uri": "https://delta.tech.local:4443/v4/restoresessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/items/AAAAAPI-ZgUzFo1OutsrlqscF3YHAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAPoX1QVx9BZHraHZM4xpWtgAARuSD4wAAA/action",

           "method": "POST"

        },

        "sendToDefaultAddress":          {

           "uri": "https://delta.tech.local:4443/v4/restoresessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/items/AAAAAPI-ZgUzFo1OutsrlqscF3YHAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAPoX1QVx9BZHraHZM4xpWtgAARuSD4wAAA/action",

           "method": "POST"

        },

        "sendToDifferentAddress":          {

           "uri": "https://delta.tech.local:4443/v4/restoresessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/items/AAAAAPI-ZgUzFo1OutsrlqscF3YHAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAPoX1QVx9BZHraHZM4xpWtgAARuSD4wAAA/action",

           "method": "POST"

        }

     },

     "id": "AAAAAPI-ZgUzFo1OutsrlqscF3YHAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAPoX1QVx9BZHraHZM4xpWtgAARuSD4wAAA"

  }],

  "_links": {"self": {"href": "https://delta.tech.local:4443/v4/RestoreSessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/Organization/Mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/action?offset=0&limit=30"}}

}

This Document Help Center
User GuideRESTful API ReferencePowerShell ReferenceVeeam Explorers User GuideVeeam Explorers PowerShell Reference
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.