Help Center
Choose product document...
Veeam Backup for Microsoft Office 365
RESTful API Reference

/RestoreSessions/{ID}/Organization/Mailboxes/{ID}/Items/{ID}

Represents the Exchange organization's backed up mailbox item with the specified ID.

Resource URL

The URL of the reference resource representation:

https://<Backup-Office365>:<Port>/v1/RestoreSessions/{ID}/Organization/Mailboxes/{ID}/Items/{ID}

Related Resources

/RestoreSessions/{ID}/Organization/Mailboxes/{ID}/Items

Methods

The following methods are supported for the /RestoreSessions/{ID}/Organization/Mailboxes/{ID}/Items/{ID} resource:

Properties

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

Task

The /RestoreSessions/{ID}/Organization/Mailboxes/{ID}/Items/{ID} 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.

For example, "Id": "AAAZXKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqADDXXAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_uoXCA==".

ItemClass

string

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

For example, "itemClass": "IPM.Task".

Status

string

Specifies the task status:

  • NotStarted
  • InProgress
  • Completed
  • WaitingOnsomeoneelse
  • Deferred

For example, "status": "Completed".

PercentComplete

int

Specifies the task progress.

For example, "percentComplete": "100".

StartDate

UTC

Specifies the date and time when the task was started.

For example, "startDate": "2017-04-04T16:08:20.2882911Z".

DueDate

UTC

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

For example, "dueDate": "2017-05-04 18:00:00".

Owner

string

Specifies the owner of the task.

For example, "owner": "j_smith@bestsupport.onmicrosoft.com".

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Journal

The /RestoreSessions/{ID}/Organization/Mailboxes/{ID}/Items/{ID} 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.

For example, "Id": "GECSFKGEj993QUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAACDFTUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u8YUU==".

ItemClass

string

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

For example, "itemClass": "IPM.Journal".

Subject

string

Specifies the task status:

  • NotStarted
  • InProgress
  • Completed
  • WaitingOnsomeoneelse
  • Deferred

For example, "status": "Completed".

StartDate

UTC

Specifies the date and time when the task was started.

For example, "startDate": "2017-04-04T16:08:20.2882911Z".

Duration

UTC

Specifies the duration of the journal entry in hours.

For example, "duration": "1".

EntryType

string

Specifies the journal entry type.

For example, "entryType": "Phone Call".

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Note

The /RestoreSessions/{ID}/Organization/Mailboxes/{ID}/Items/{ID} 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.

For example, "Id": "CVVNHTGEj993QUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAACDFTUcAAEJD8-PTGuNAoFrJGmIzcMoAAE-h_u2MNN==".

ItemClass

string

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

For example, "itemClass": "IPM.Note".

Name

string

Specifies the name of the note.

For example, "name": "Important".

Date

string

Specifies the date when the note was created.

For example, "date ": "6/5/2017 1:12 PM".

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Message

The /RestoreSessions/{ID}/Organization/Mailboxes/{ID}/Items/{ID} 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.

For example, "Id": "KLM73GGEj998QUtGjuSnqNCREAgHAPliTMf_6DxPiJ6TGYfGGrBWqCDFTUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u8YUU==".

ItemClass

string

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

For example, "itemClass": "IPM.Message".

From

string

Specifies the sender mailbox e-mail address.

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

To

string

Specifies the recipient mailbox e-mail address.

For example, "to ": "qa_dallas@tech.onmicrosoft.com".

Cc

string

Specifies the recipient e-mail address in carbon copy.

For example, "cc": "qa@bestsupport.onmicrosoft.com".

Bcc

string

Specifies the recipient address in blind carbon copy.

For example, "bcc": "rnd@bestsupport.onmicrosoft.com".

Subject

string

Specifies the subject of the e-mail message.

For example, "subject": "Support case".

Sent

UTC

Specifies the date and time when the message was sent.

For example, "sent": "2017-05-25T08:39:16.8235249Z".

Received

UTC

Specifies the date and time when the message was received.

For example, "received": "2017-05-25T08:39:16.8235249Z".

Reminder

bool

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

For example, "reminder": "false".

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Appointment

The /RestoreSessions/{ID}/Organization/Mailboxes/{ID}/Items/{ID} 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.

For example, "Id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==".

ItemClass

string

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

For example, "itemClass": "IPM.Appointment".

StartTime

UTC

Specifies the when the appointment starts.

For example, "startTime": "2022-10-09T21:00:00Z".

EndTime

UTC

Specifies when the appointment finishes.

For example, "endTime": "2022-10-10T21:00:00Z".

Organizer

string

Specifies the appointment's organizer.

For example, "organizer": "j_smith@bestsupport.onmicrosoft.com".

Location

string

Specifies the location where the appointment is held.

For example, "location": "Confroom07".

Attendees

string[]

Specifies the appointment's attendees.

For example, "attendees": "qa@bestsupport.onmicrosoft.com".

Recurring

bool

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

For example, "recurring": "false".

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Resource Representation

The /RestoreSessions/{ID}/Organization/Mailboxes/{ID}/Items/{ID} resource for the Appointment item has the following representation:

  {

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

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

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

     "location": "Confroom07",

     "attendees": "qa@bestsupport.onmicrosoft.com",

     "recurring": "false",

     "itemClass": "IPM.Appointment",

     "_links": {

       "self": {

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

       },

       "parent": {

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

       },

       "mailbox": {

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

       }

     },

     "_actions": {

       "restoretoOriginallocation": {

         "uri": "https://support.east.local:4443/v1/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://support.east.local:4443/v1/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://support.east.local:4443/v1/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://support.east.local:4443/v1/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://support.east.local:4443/v1/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://support.east.local:4443/v1/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=="

     }

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference