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

Getting Mailbox Items

Returns a resource representation of an organization's mailbox item with a specified ID.

Request

GET https://<hostname>:4443/v4/RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Items/{itemId}

Request Headers

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

Request Body

None.

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

Exchange organizations use Items to represent individual email messages, appointments, journals and other items in a mailbox. The /RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Items/{itemId} resource has different properties depending on the item type.

Task

The /RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Items/{itemId} resource for the Task item has the following properties:

Property

Type

Description

Id

string

Specifies the ID of the organization's backed up mailbox item.

ItemClass

string

Specifies the class of the organization's backed up mailbox item.

Status

string

Specifies the task status:

  • NotStarted
  • InProgress
  • Completed
  • WaitingOnsomeoneelse
  • Deferred

PercentComplete

int

Specifies the task progress.

StartDate

UTC

Specifies the date and time when the task was started.

DueDate

UTC

Specifies the date and time when the task must be completed.

Owner

string

Specifies the owner of the task.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Journal

The /RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Items/{itemId} resource for the Journal item has the following properties:

Property

Type

Description

Id

string

Specifies the ID of the organization's backed up mailbox item.

ItemClass

string

Specifies the class of the organization's backed up mailbox item.

Subject

string

Specifies the task status:

  • NotStarted
  • InProgress
  • Completed
  • WaitingOnsomeoneelse
  • Deferred

StartDate

UTC

Specifies the date and time when the task was started.

Duration

UTC

Specifies the duration of the journal entry in hours.

EntryType

string

Specifies the journal entry type.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Note

The /RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Items/{itemId} resource for the Note item has the following properties:

Property

Type

Description

Id

string

Specifies the ID of the organization's backed up mailbox item.

ItemClass

string

Specifies the class of the organization's backed up mailbox item.

Name

string

Specifies the name of the note.

Date

string

Specifies the date when the note was created.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Message

The /RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Items/{itemId} resource for the Message item has the following properties:

Property

Type

Description

Id

string

Specifies the ID of the organization's backed up mailbox item.

ItemClass

string

Specifies the class of the organization's backed up mailbox item.

From

string

Specifies the sender mailbox email address.

To

string

Specifies the recipient mailbox email address.

Cc

string

Specifies the recipient email address in carbon copy.

Bcc

string

Specifies the recipient address in blind carbon copy.

Subject

string

Specifies the subject of the email message.

Sent

UTC

Specifies the date and time when the message was sent.

Received

UTC

Specifies the date and time when the message was received.

Reminder

boolean

If set to True, indicates that the message was sent with the reminder.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Appointment

The /RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Items/{itemId} resource for the Appointment item has the following properties:

Property

Type

Description

Id

string

Specifies the ID of the organization's backed up mailbox item.

ItemClass

string

Specifies the class of the organization's backed up mailbox item.

StartTime

UTC

Specifies the when the appointment starts.

EndTime

UTC

Specifies when the appointment finishes.

Organizer

string

Specifies the appointment's organizer.

Location

string

Specifies the location where the appointment is held.

Attendees

string[]

Specifies the appointment's attendees.

Recurring

boolean

If set to True, specifies that the appointment is recurring.

Attachments

attachment

Specifies attachment items for the appointment item.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Attachments

The appointment attachment item has the following properties:

Property

Type

Description

Name

string

Specifies a name of an attachment item.

Size

string

Specifies a size of an attachment item.

Contact

The /RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Items/{itemId} resource for the Contact item has the following properties:

Property

Type

Description

FullName

string

Specifies the name of the name of the contact.

Mobile

string

Specifies the mobile phone number of the contact.

HomePhone

string

Specifies the home phone number of the contact.

Fax

string

Specifies the fax number of the contact.

Address

string

Specifies the contact address.

Company

string

Specifies the company of the contact.

JobTitle

string[]

Specifies the contact's job title.

Email

string

Specifies the contact's email.

BusinessPhone

string

Specifies the business phone number of the contact.

WebPage

string

Specifies the web page of the contact.

Example

The following request returns an entity representation of the organization's mailbox item with ID AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==.

Request:

GET https://abc.tech.local:4443/v4/RestoreSessions/479ae6aa-610b-4652-8966-5db06021903c/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

     "startTime": "2022-10-09T21:00:00Z",

     "endTime": "2022-10-10T21:00:00Z",

     "organizer": "jsmith",

     "location": "United States",

     "attendees": "",

     "recurring": "false",

     "itemClass": "IPM.Appointment",

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v4/restoresessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA=="

       },

       "parent": {

         "href": "https://abc.tech.local:4443/v4/restoresessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAA=="

       },

       "mailbox": {

         "href": "https://abc.tech.local:4443/v4/restoresessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

       }

     },

     "_actions": {

       "restoretoOriginallocation": {

         "uri": "https://abc.tech.local:4443/v4/restoresessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==/action",

         "method": "POST"

       },

       "restoreTo": {

         "uri": "https://abc.tech.local:4443/v4/restoresessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==/action",

         "method": "POST"

       },

       "exporttoPst": {

         "uri": "https://abc.tech.local:4443/v4/restoresessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==/action",

         "method": "POST"

       },

       "savetoMsg": {

         "uri": "https://abc.tech.local:4443/v4/restoresessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==/action",

         "method": "POST"

       },

       "sendtoDefaultaddress": {

         "uri": "https://abc.tech.local:4443/v4/restoresessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==/action",

         "method": "POST"

       },

       "sendtoDifferentaddress": {

         "uri": "https://abc.tech.local:4443/v4/restoresessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==/action",

         "method": "POST"

       }

     },

     "id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA=="

       }

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.