Verweisressourcen für die APIs für Mail, Kalender, Kontakte und Aufgaben-REST (Version 2.0)

Gilt für:Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com** **

Dieser Artikel beschreibt die REST-API-Entitäten, Eigenschaften, komplexen Typen, Aufzählungen und OData-Abfrageparameter, die Sie mit Outlook Mail , Kalender , Kontakte und Aufgabe API verwenden können, um auf Benutzerpostfachdaten in Office 365, Hotmail.com, Live.com, MSN.com, Outlook.com und Passport.com zuzugreifen.

Hinweis

Zur Vereinfachung des Verweises verwendet der Rest dieses Artikels Outlook.com, um diese Microsoft-Kontodomänen einzuschließen.

Weitere Informationen, die allen Untergruppen von Outlook-REST-API gemeinsam sind, finden Sie unter Outlook-REST-API verwenden.

Kein Interesse an v2.0 der API? Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365 REST API-Referenz und wählen Sie die gewünschte Version aus.

Tipp

Sie können das komplette Metadaten-Dokument für das Entitätsdatenmodell Mail, Kalender, Kontakte und Aufgaben anzeigen, indem Sie zum $metadata Endpunkt in einem Webbrowser navigieren (z. B. https://outlook.office.com/api/v2.0/$metadata).

Anlage

Eine Datei oder ein Element (Kontakt, Ereignis oder Nachricht), die einem Ereignis, einer Nachricht, oder einer Aufgabeangefügt ist. Die entsprechenden fileAttachment -, itemAttachment - und referenceAttachment-Ressourcen werden alle von der Anlagen Ressource abgeleitet.

Typ: Microsoft.OutlookServices.Entity

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
ContentType Zeichenfolge Der MIME-Typ der Anlage. Ja Nein
IsInline Boolesch true wenn die Anlage eine Inlineanlage ist, andernfalls false. Ja Ja
LastModifiedDateTime DateTimeOffset Datum und Uhrzeit der letzten Änderung der Anlage. Das Datum und die Uhrzeit verwenden das ISO 8601-Format und sind immer in UTC-Zeit angegeben.

Zum Beispiel würde Mitternacht UTC am 1. Januar 2014 so aussehen: '2014-01-01T00:00:00Z'
Nein Ja
Name Zeichenfolge Der Anzeigename der Anlage. Dies muss nicht der aktuelle Dateiname sein. Ja Ja
Größe Int32 Die Länge der Anlage in Byte. Nein Nein

Kalender

Ein Kalender, der ein Container für Ereignisse ist.

Typ: Microsoft.OutlookServices.Calendar

Eine Kalender-Sammlung gibt ein Array von Kalendern in der Wert Eigenschaft der OData-Antwort zurück. Mit $count können Sie die Anzahl der Objekte in der Sammlung ermitteln: .../me/calendars/$count

Unterstützte Aktionen finden Sie unter Kalenderoperationen.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
CanEdit Boolesch „True“, wenn der Benutzer in den Kalender schreiben kann, andernfalls „false“. Diese Eigenschaft ist für den Benutzer, der den Kalender erstellt hat, „true“. Diese Eigenschaft ist auch für einen Benutzer „true“, für den ein Kalender freigegeben wurde und der Schreibzugriff hat. Nein Ja
CanShare Boolesch „True“, wenn der Benutzer die Berechtigung zum Freigeben des Kalenders hat, andernfalls „false“. Nur der Benutzer, der den Kalender erstellt hat, kann ihn freigeben. Nein Ja
CanViewPrivateItems Boolesch „True“, wenn der Benutzer Elemente im Kalender lesen kann, die als „privat“ markiert wurden, andernfalls „false“. Nein Ja
ChangeKey Zeichenfolge Identifiziert die Version des Kalenderobjekts. Jedes Mal, wenn der Kalender geändert wird, ändert sich auch der ChangeKey. Dies ermöglicht es Exchange, die Änderungen an der richtigen Version des Objekts anzuwenden. Nein Nein
Farbe CalendarColor Gibt das Farbdesign an, um den Kalender von anderen Kalendern in einer Benutzeroberfläche zu unterscheiden. Die Eigenschaftswerte sind: LightBlue=0, LightGreen=1, LightOrange=2, LightGray=3, LightYellow=4, LightTeal=5, LightPink=6, LightBrown=7, LightRed=8, MaxColor=9, Auto=-1 Ja Ja
ID Zeichenfolge Der eindeutige Bezeichner des Kalenders. Nein Nein
Name Zeichenfolge Der Kalendername. Ja Ja
Besitzer EmailAddress Wenn eingestellt, repräsentiert dies den Benutzer, der den Kalender erstellt oder hinzugefügt hat. Für einen Kalender, den der Benutzer erstellt oder hinzugefügt hat, wird die Eigenschaft Besitzer auf den Benutzer eingestellt. Für einen mit dem Benutzer geteilten Kalender wird die Eigenschaft Besitzer auf die Person eingestellt, die diesen Kalender mit dem Benutzer geteilt hat. Nein Ja
CalendarView Sammlung (Ereignis) Die Kalenderansicht für den Kalender. Navigationseigenschaft. Nein Nein
Ereignisse Sammlung (Ereignis) Die Ereignisse im Kalender. Navigationseigenschaft. Nein Nein
MultiValueExtendedProperties Eine Sammlung Eine Sammlung von erweiterten Mehrfachwert-Eigenschaften vom Typ MultiValueLegacyExtendedProperty. Dies ist eine Navigationseigenschaft.

Weitere Informationen über erweiterte Eigenschaften.
Ja Ja
SingleValueExtendedProperties Eine Sammlung Eine Sammlung von erweiterten Einwert-Eigenschaften vom Typ SingleValueLegacyExtendedProperty. Dies ist eine Navigationseigenschaft.

Weitere Informationen über erweiterte Eigenschaften.
Ja Ja

CalendarGroup

Eine Gruppe von Kalendern.

Hinweis

Outlook.com unterstützt nur die Standardkalendergruppe, die über die Verknüpfung ../me/calendars erreichbar ist. Sie können diese Kalendergruppe nicht löschen.

Typ: Microsoft.OutlookServices.CalendarGroup

Eine CalendarGroup-Sammlung gibt ein Array von Kalendergruppen in der Wert Eigenschaft der OData-Antwort zurück. Mit $count können Sie die Anzahl der Objekte in der Sammlung ermitteln: .../me/calendargroups/$count

Unterstützte Aktionen finden Sie unter CalendarGroup-Operationen.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
Name Zeichenfolge Der Gruppenname. Ja Ja
ChangeKey Zeichenfolge Identifiziert die Version der Kalendergruppe. Jedes Mal, wenn die Kalendergruppe geändert wird, ändert sich auch der ChangeKey. Dies ermöglicht es Exchange, die Änderungen an der richtigen Version des Objekts anzuwenden. Nein Nein
ClassId Zeichenfolge Der Klassenbezeichner. Nein Ja
ID Zeichenfolge Der eindeutige Bezeichner der Kalendergruppe. Nein Nein
Kalender Sammlung (Kalender) Die Kalender in der Kalendergruppe. Navigationseigenschaft. Nein Nein

Kontakt

Ein Kontakt, der ein Element in Outlook ist, mit dem Benutzer Informationen über die Personen und Organisationen, mit denen sie kommunizieren, organisieren und speichern können. Kontakte sind in Kontaktordnern enthalten.

Typ: Microsoft.OutlookServices.Contact

Eine Kontaktsammlung gibt ein Array von Kontakten in der Wert Eigenschaft der OData-Antwort zurück. Mit $count können Sie die Anzahl der Objekte in der Sammlung ermitteln: .../me/contacts/$count

Unterstützte Aktionen finden Sie unter Kontaktoperationen.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
AssistantName Zeichenfolge Der Name des Assistenten des Kontakts. Ja Ja
Geburtstag datetimeoffset Das Geburtsdatum des Kontakts. Ja Ja
BusinessAddress PhysicalAddress Die Geschäftsadresse des Kontakts. Ja Ja
BusinessHomePage Zeichenfolge Die geschäftliche Homepage des Kontakts. Ja Ja
BusinessPhones Sammlung (Zeichenfolge) Die geschäftlichen Telefonnummern des Kontakts. Ja Nein
Kategorien Sammlung (Zeichenfolge) Die Kategorien, die mit dem Kontakt verknüpft sind. Ja Nein
ChangeKey Zeichenfolge Identifiziert die Version des Kontakts. Jedes Mal, wenn der Kontakt geändert wird, ändert sich auch der ChangeKey. Dies ermöglicht es Exchange, die Änderungen an der richtigen Version des Objekts anzuwenden. Nein Nein
Untergeordnete Objekte Sammlung (Zeichenfolge) Die Namen der untergeordneten Elemente des Kontakts. Ja Ja
CompanyName Zeichenfolge Der Name des Unternehmens des Kontakts. Ja Ja
Abteilung Zeichenfolge Die Abteilung des Kontakts. Ja Ja
CreatedDateTime datetimeoffset Die Zeit, zu der der Kontakt erstellt wurde. Nein Ja
LastModifiedDateTime datetimeoffset Die Änderungszeit des Kontakts. Nein Ja
DisplayName Zeichenfolge Der Anzeigename des Kontakts. Ja Ja
EmailAddresses Sammlung (EmailAdresse) Die E-Mail-Adressen des Kontakts. Ja Nein
Erweiterungen Sammlung (Erweiterung) Die Sammlung von Datenerweiterungen offenen Typs, die für den Kontakt definiert sind. Navigationseigenschaft. Nein Ja
FileAs Zeichenfolge Der Name, unter dem der Kontakt abgelegt ist. Ja Ja
Generation Zeichenfolge Die Generierung des Kontakts. Ja Ja
GivenName Zeichenfolge Der Vorname des Kontakts. Ja Ja
HomeAddress PhysicalAddress Die Privatadresse des Kontakts. Ja Ja
HomePhones Sammlung (Zeichenfolge) Die privaten Telefonnummern des Kontakts. Ja Nein
ID Zeichenfolge Eindeutiger Bezeichner für den Kontakt. Nein Nein
ImAddresses Sammlung (Zeichenfolge) Die Instant Messaging (IM) Adressen des Kontakts. Ja Nein
Initialen Zeichenfolge Die Initialen des Kontakts. Ja Ja
JobTitle Zeichenfolge Die Position des Kontakts. Ja Ja
Vorgesetzter Zeichenfolge Der Name des Vorgesetzten des Kontakts. Ja Ja
MiddleName Zeichenfolge Der zweite Vorname des Kontakts. Ja Ja
MobilePhone1 Zeichenfolge Die Mobiltelefonnummer des Kontakts. Ja Ja
NickName Zeichenfolge Der Spitzname des Kontakts. Ja Ja
OfficeLocation Zeichenfolge Der Bürostandort des Kontakts. Ja Ja
OtherAddress PhysicalAddress Weitere Adressen für den Kontakt. Ja Ja
ParentFolderId Zeichenfolge Die ID des übergeordneten Ordners des Kontakts. Nein Nein
PersonalNotes Zeichenfolge Die Notizen des Benutzers zu dem Kontakt. Ja Ja
Beruf Zeichenfolge Der Beruf des Kontakts. Ja Ja
SpouseName Zeichenfolge Der Name des Ehepartners des Kontakts. Ja Ja
Nachname Zeichenfolge Der Nachname des Kontakts. Ja Ja
Titel Zeichenfolge Der Titel des Kontakts. Ja Nein
YomiCompanyName Zeichenfolge Der phonetische japanische Firmenname des Kontakts. Ja Nein
YomiGivenName Zeichenfolge Der phonetische japanische Vorname des Kontakts. Ja Nein
YomiSurname Zeichenfolge Der phonetische japanische Nachname des Kontakts. Ja Nein

Die Navigationseigenschaften MultiValueExtendedProperties und SingleValueExtendedProperties stehen auch für diese Ressource zur Verfügung, um Sammlungen der jeweiligen Typen von erweiterten Eigenschaften darzustellen, die für eine Ressourceninstanz definiert wurden. Weitere Informationen finden Sie unter Erweiterte Eigenschaften REST-API.

ContactFolder

Ein Ordner, der Kontakte enthält.

Typ: Microsoft.OutlookServices.ContactFolder

Eine ContactFolder-Sammlung gibt ein Array von Kontaktordnern in der Wert Eigenschaft der OData-Antwort zurück. Mit $count können Sie die Anzahl der Objekte in der Sammlung ermitteln: .../me/contactfolders/$count

Unterstützte Aktionen finden Sie unter ContactFolder-Operationen.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
ChildFolders Sammlung (ContactFolder) Die Sammlung von untergeordneten Ordnern im Ordner. Navigationseigenschaft. Nein Nein
Kontakte Sammlung (Kontakt) Die Kontakte im Ordner. Navigationseigenschaft. Nein Nein
DisplayName Zeichenfolge Der Anzeigename des Ordners. Ja Ja
ID Zeichenfolge Eindeutiger Bezeichner des Kontaktordners. Nein Nein
ParentFolderId Zeichenfolge Die ID des übergeordneten Ordners des Ordners. Nein Nein
MultiValueExtendedProperties Eine Sammlung Eine Sammlung von erweiterten Mehrfachwert-Eigenschaften vom Typ MultiValueLegacyExtendedProperty. Dies ist eine Navigationseigenschaft.

Weitere Informationen über erweiterte Eigenschaften.
Ja Ja
SingleValueExtendedProperties Eine Sammlung Eine Sammlung von erweiterten Einwert-Eigenschaften vom Typ SingleValueLegacyExtendedProperty. Dies ist eine Navigationseigenschaft.

Weitere Informationen über erweiterte Eigenschaften.
Ja Ja

Ereignis

Ein Ereignis in einem Kalender

Typ: Microsoft.OutlookServices.Event

Eine Ereignissammlung gibt ein Array von Ereignissen in der Wert Eigenschaft der OData-Antwort zurück. Mit $count können Sie die Anzahl der Objekte in der Sammlung ermitteln: .../me/events/$count

Unterstützte Aktionen finden Sie unter Ereignisoperationen.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
Anlagen Sammlung (Anlage) Die Sammlung von FileAttachment-, ItemAttachment- und ReferenceAttachment-Anlagen für das Ereignis. Navigationseigenschaft. Nein Nein
Teilnehmer Sammlung (Teilnehmer) Die Sammlung der Teilnehmer für das Ereignis. Ja Nein
Text ItemBody Der Text der Nachricht, die mit diesem Ereignis verknüpft ist. Ja Nein
BodyPreview Zeichenfolge Die Vorschau der Nachricht, die mit dem Ereignis verknüpft ist. Nein Nein
Kalender Kalender Der Kalender, der das Ereignis enthält. Navigationseigenschaft. Nein Nein
Kategorien Sammlung (Zeichenfolge) Die Kategorien, die mit dem Ereignis verknüpft sind. Ja Nein
ChangeKey Zeichenfolge Gibt die Version des Ereignisobjekts an. Jedes Mal, wenn das Ereignis geändert wird, wird auch die Eigenschaft „changeKey“ geändert. Auf diese Weise kann Exchange Änderungen an der korrekten Version des Objekts vornehmen. Nein Nein
CreatedDateTime datetimeoffset Das Datum und die Uhrzeit, zu dem bzw. zu der das Ereignis erstellt wurde. Nein Ja
LastModifiedDateTime datetimeoffset Das Datum und die Uhrzeit, zu dem bzw. zu der das Ereignis zuletzt geändert wurde. Nein Ja
Ende DateTimeTimeZone Die Endzeit des Ereignisses. Ja Ja
Erweiterungen Sammlung (Erweiterung) Die Sammlung von Datenerweiterungen offenen Typs, die für das Ereignis definiert sind. Navigationseigenschaft. Nein Ja
HasAttachments boolesch Auf "Wahr" setzen, wenn das Ereignis Anhänge enthält. Nein Ja
ID Zeichenfolge Der eindeutige Bezeichner des Ereignisses. Nein Nein
Bedeutung Bedeutung Die Bedeutung des Ereignisses: Low, Normal, High. Ja Ja
Instanzen Sammlung (Ereignis) Die Instanzen des Ereignisses. Navigationseigenschaft. Nein Nein
iCalUID Zeichenfolge Ein eindeutiger Bezeichner, der für alle Instanzen eines Ereignisses in unterschiedlichen Kalendern verwendet wird. Nein Ja
IsAllDay boolesch Auf "Wahr" setzen, wenn das Ereignis den ganzen Tag dauert. Für das Anpassen dieser Eigenschaft müssen auch die Start- und Ende-Eigenschaften des Ereignisses angepasst werden. Ja Ja
IsCancelled boolesch Auf "Wahr" setzen, wenn das Ereignis abgesagt wurde. Ja Ja
IsOrganizer boolesch Auf "Wahr" setzen, wenn der Absender der Nachricht auch der Organisator ist. Ja Ja
IsReminderOn Boolesch Auf "Wahr" einstellen, wenn eine Benachrichtigung eingestellt wurde, um den Benutzer an das Ereignis zu erinnern. Ja Ja
Aufenthaltsort Aufenthaltsort Der Aufenthaltsort des Ereignisses. Ja Ja
OnlineMeetingUrl Zeichenfolge Eine URL für eine Onlinebesprechung. Ja Nein
Organisator Empfänger Der Organisator des Ereignisses. Ja Ja
OriginalEndTimeZone Zeichenfolge Die Zeitzone, die bei der Erstellung des Ereignisses für das Ereignisende festgelegt wurde. Eine Liste der gültigen Zeitzonen finden Sie unter DateTimeTimeZone. Nein Ja
OriginalStartTimeZone Zeichenfolge Die Zeitzone, die bei der Erstellung des Ereignisses für den Ereignisbeginn festgelegt wurde. Eine Liste der gültigen Zeitzonen finden Sie unter DateTimeTimeZone. Nein Ja
Serie PatternedRecurrence Das Serienmuster für das Ereignis. Ja Nein
ReminderMinutesBeforeStart Int32 Festlegung, wie viele Minuten vor Beginn des Ereignisses die Erinnerung angezeigt werden soll. Ja Nein
ResponseRequested boolesch Legen Sie „Wahr“ fest, wenn der Absender eine Antwort erhalten möchte, wenn das Ereignis akzeptiert oder abgelehnt wird. Ja Ja
ResponseStatus ResponseStatus Gibt den Typ der Antwort an, die als Antwort auf eine Ereignisnachricht gesendet wurde. Nein Ja
Vertraulichkeit Vertraulichkeit Gibt die Datenschutzebene für das Ereignis an: Normal = 0, Persönlich = 1, Privat = 2, Vertraulich = 3. Ja Ja
SeriesMasterId Zeichenfolge Die dem Element zugeordneten Kategorien. Ja Nein
ShowAs FreeBusyStatus Der anzuzeigende Status: Frei = 0, Mit Vorbehalt = 1, Beschäftigt = 2, Abwesend = 3, An anderem Ort tätig = 4; Unbekannt =-1. Ja Ja
Start DateTimeTimeZone Die Startzeit des Ereignisses. Ja Ja
Typ EventType Der Ereignistyp: SingleInstance = 0, Vorkommen = 1, Ausnahme= 2, SeriesMaster = 3. Ja Ja
WebLink Zeichenfolge Die URL zum Öffnen des Ereignisses in Outlook Web App:

Das Ereignis wird im Browser geöffnet, wenn Sie über Outlook Web App bei Ihrem Postfach angemeldet sind. Sie werden aufgefordert, sich anzumelden, wenn Sie noch nicht beim Browser angemeldet sind.

Auf diese URL kann von einem iFrame aus zugegriffen werden.
Nein Nein

Die Navigationseigenschaften MultiValueExtendedProperties und SingleValueExtendedProperties stehen auch für diese Ressource zur Verfügung, um Sammlungen der jeweiligen Typen von erweiterten Eigenschaften darzustellen, die für eine Ressourceninstanz definiert wurden. Weitere Informationen finden Sie unter Erweiterte Eigenschaften REST-API.

EventMessage

Eine Nachricht, die eine Besprechungsanfrage darstellt, Nachricht über die Absage einer Besprechung, Nachricht zur Annahme einer Besprechung, Nachricht über die Zusage mit Vorbehalt oder Nachricht über das Ablehnen der Besprechung.

Basistyp: Nachricht

Eine EventMessage Instanz befindet sich gewöhnlich im Posteingangsordner, wo sie entweder ankommt, weil ein Ereignisorganisator eine Besprechung erstellt, oder weil ein Teilnehmer auf eine Besprechungsanfrage antwortet. Mit Ereignisnachrichten gehen Sie genauso wie mit anderen Nachrichten um, abgesehen von einigen kleinen Unterschieden, die in der folgenden Tabelle beschrieben sind.

Aktion/Verb Berechtigung Beschreibung
Eine Ereignisnachricht melden (POST) Nicht zutreffend Nicht erlaubt. Ergibt den Antwortcode 400.
Eine Ereignisnachricht aktualisieren (PATCH) Mail.Write Sie können die Eigenschaften Von, Absender, ToRecipients, CcRecipients, BccRecipients, ReplyTo, IsDeliveryReceiptRequested, IsReadReceiptRequested, IsDraft, IsRead, Betreff, Text, Wichtigkeit und Kategorien aktualisieren.
Eine Ereignisnachricht löschen (DELETE) Mail.Write Gleiche Aktion wie für eine Nachricht.
Eine Ereignisnachricht verschieben (POST) Mail.Write Gleiche Aktion wie für eine Nachricht.
Eine Ereignisnachricht kopieren (POST) Mail.Write Gleiche Aktion wie für eine Nachricht.
Einen Antwortnachrichtentwurf erstellen (POST) Mail.Write Gleiche Aktion wie für eine Nachricht.
Antwortentwurf für alle Nachrichten erstellen (POST) Mail.Write Gleiche Aktion wie für eine Nachricht.
Eine Antwort erstellen (POST) Mail.Write Gleiche Aktion wie für eine Nachricht.
Allen Antworten erstellen (POST) Mail.Write Gleiche Aktion wie für eine Nachricht.
Eine vorhandene Ereignisnachricht senden (POST) Mail.Write Sie können nur dann eine Ereignisnachricht senden, wenn die IsDraft-Eigenschaft den Wert wahr hat. Eine Kopie der Nachricht wird im Ordner Gesendete Objekte gespeichert.
Einen Entwurf für eine Weiterleitungsnachricht für ein Ereignis erstellen Mail.Write Gleiche Aktion wie für eine Nachricht.
Eine Ereignisnachricht weiterleiten Mail.Write Gleiche Aktion wie für eine Nachricht.

Eine EventMessage-Instanz enthält Eigenschaften des Basistyps Nachricht sowie die Eigenschaften in der folgenden Tabelle.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
Ereignis Ereignis Das Ereignis, das der Ereignisnachricht zugeordnet ist. Für Teilnehmer oder Raumressourcen wird davon ausgegangen, dass die Kalenderautomatik für die automatische Aktualisierung des Kalenders mit einem Ereignis festgelegt ist, wenn Ereignisnachrichten mit Besprechungsanfragen eingehen. Navigationseigenschaft. Nein Nein
MeetingMessageType MeetingMessageType Der Typ der Ereignismeldung: Keine = 0, MeetingRequest = 1, MeetingCancelled = 2, MeetingAccepted = 3, MeetingTentativelyAccepted = 4, MeetingDeclined = 5 Nein Ja

EventMessageRequest (Vorschau)

Dieses Feature ist derzeit in der Beta-Version verfügbar. Um mehr zu erfahren, wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365-REST-API-Referenz und wählen Sie beta.

Erweiterte Eigenschaften

Sie können eine benutzerdefinierte Eigenschaft auf einer Entität als MultiValueLegacyExtendedProperty oder SingleValueLegacyExtendedProperty erstellen, je nach den für die Eigenschaft vorgesehenen Werten.

MultiValueLegacyExtendedProperty

Eine erweiterte Eigenschaft, die eine Sammlung von mehreren Werten enthalten kann.

Typ: Microsoft.OutlookServices.MultiValueLegacyExtendedProperty

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
Wert Sammlung (Zeichenfolge) Eine Sammlung von Eigenschaftswerten. Ja Nein
PropertyId Zeichenfolge Die Eigenschafts-ID. Diese wird zur Identifizierung der Eigenschaft verwendet. Nein Nein

SingleValueLegacyExtendedProperty

Eine erweiterte Eigenschaft, die einen einfachen Wert enthält.

Typ: Microsoft.OutlookServices.SingleValueLegacyExtendedProperty

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
Wert Zeichenfolge Ein Eigenschaftswert. Ja Nein
PropertyId Zeichenfolge Die Eigenschafts-ID. Diese wird zur Identifizierung der Eigenschaft verwendet. Nein Ja

Beim Erstellen einer erweiterten Eigenschaft gibt es verschiedene Möglichkeiten, die PropertyId anzugeben. Weitere Infromationen finden Sie unter PropertyId-Formate.

Sehen Sie die Erweiterten Eigenschaften REST-API-Referenz für die zugehörigen Vorgänge, die Sie verwenden können.

FileAttachment

Eine Datei (z. B. eine Textdatei oder ein Word-Dokument), die an eine Nachricht, ein Ereignis oder einer Aufgabe angefügt ist. Die ContentBytes Eigenschaft enthält den base64-codierten Inhalt der Datei. Abgeleitet von der Anlagen Entität.

Typ: Microsoft.OutlookServices.FileAttachment** **

Basistyp: Microsoft.OutlookServices.Attachment

Eigenschaft Typ Beschreibung Beschreibbar?
ContentBytes Binär Der binäre Inhalt der Datei. Nein
ContentId Zeichenfolge Die ID der Anlage im Exchange-Speicher. Nein
ContentLocation Zeichenfolge Der URI (Uniform Resource Identifier), der dem Speicherort des Anlageninhalts entspricht. Nein
ContentType Zeichenfolge Der Inhaltstyp der Anlage. Ja
LastModifiedDateTime datetimeoffset Datum und Uhrzeit der letzten Änderung der Anlage. Nein
ID Zeichenfolge Die Anlagen-ID. Nein
IsInline boolesch Auf "Wahr" setzen, wenn es sich um eine Inlineanlage handelt. Ja
Name Zeichenfolge Der Name, der den Text darstellt, der unter dem Symbol für die eingebettete Anlage angezeigt wird. Dies muss nicht der tatsächliche Dateiname sein. Ja
Größe Int32 Die Größe der Anlage in Byte. Nein

Ordner / MailFolder

Hinweis

In v2.0 wurden Entität und Typ, die vorher als Ordner bekannt waren, in MailFolder umbenannt.

Ein Ordner im Postfach eines Benutzers, z.B. Posteingang, Entwürfe und Gesendete Objekte. Ordner können Nachrichten und andere Ordner enthalten.

Typ: Microsoft.OutlookServices.MailFolder

Eine MailFolders-Sammlung gibt ein Array von Ordnern in der Wert Eigenschaft der OData-Antwort zurück. Mit $count können Sie die Anzahl der Objekte in der Sammlung ermitteln: .../me/folders/$count

Unterstützte Aktionen finden Sie unter Ordneroperationen.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
ChildFolderCount Int32 Die Anzahl der Ordner im Ordner. Nein Ja
ChildFolders Sammlung (MailFolder) Die Sammlung von untergeordneten Ordnern im Ordner. Navigationseigenschaft. Nein Nein
DisplayName Zeichenfolge Der Anzeigename des Ordners. Ja Ja
ID Zeichenfolge Der eindeutige Bezeichner des Ordners. Sie können die folgenden bekannten Namen verwenden, um auf den entsprechenden Ordner zuzugreifen:Posteingang, Entwürfe, SendItems, DeletedItems. Nein Nein
Nachrichten Sammlung (Message) Die Sammlung von Nachrichten im Ordner. Navigationseigenschaft. Nein Nein
ParentFolderId Zeichenfolge Der eindeutige Bezeichner für den übergeordneten Ordner des Ordners. Nein Nein
TotalItemCount Int32 Die Anzahl der Elemente im Ordner. Nein Ja
UnreadItemCount Int32 Die Anzahl der Elemente im Ordner, die als „Ungelesen“ markiert sind. Nein Ja
MultiValueExtendedProperties Eine Sammlung Eine Sammlung von erweiterten Mehrfachwert-Eigenschaften vom Typ MultiValueLegacyExtendedProperty. Dies ist eine Navigationseigenschaft.

Weitere Informationen über erweiterte Eigenschaften.
Ja Ja
SingleValueExtendedProperties Eine Sammlung Eine Sammlung von erweiterten Einwert-Eigenschaften vom Typ SingleValueLegacyExtendedProperty. Dies ist eine Navigationseigenschaft.

Weitere Informationen über erweiterte Eigenschaften.
Ja Ja

Effizientes Zählen der Elementzugriffe

Mit den Eigenschaften TotalItemCount und UnreadItemCount eines Ordners können Sie die Anzahl der gelesenen Elemente im Ordner problemlos ermitteln. Mithilfe dieser Eigenschaften werden Abfragen folgender Art vermieden, die zu erheblichen Wartezeiten führen:

https://outlook.office.com/api/v2.0/me/mailfolders/inbox/messages?$count=true&$filter=isread%20eq%20false

Ordner in Outlook können mehr als einen Typ von Elementen enthalten, der Posteingang kann beispielsweise Besprechungsanfragen enthalten, die sich von E-Mail-Elementen unterscheiden. TotalItemCount und UnreadItemCount schließen Elemente in einem Ordner unabhängig von Elementtyp ein.

InferenceClassification

Klassifizierung der Nachrichten eines Benutzers, um den Fokus auf die Nachrichten zu legen, die für den Benutzer relevanter oder wichtiger sind.

Typ: Microsoft.OutlookServices.InferenceClassification

Eigenschaft Typ Beschreibung Beschreibbar?
Außerkraftsetzungen Sammlung (InferenceClassificationOverride) Eine Reihe von Außerkraftsetzungen für einen Benutzer, um Nachrichten von bestimmten Absendern immer auf eine bestimmte Art und Weise zu klassifizieren, wie von InferenceClassificationType unterstützt. Navigationseigenschaft. Ja

InferenceClassificationOverride

Stellt die Außerkraftsetzung eines Benutzers dafür dar, wie eingehende Nachrichten von einem bestimmten Absender immer klassifiziert werden sollen.

Typ: Microsoft.OutlookServices.InferenceClassificationOverride

Eigenschaft Typ Beschreibung Beschreibbar?
ClassifyAs InferenceClassificationType Gibt an, wie eingehende Nachrichten von einem bestimmten Absender immer klassifiziert werden sollen. Relevant=0, Andere=1. Ja
ID Zeichenfolge Der eindeutige Bezeichner der Außerkraftsetzung. Nein
SenderEmailAddress EmailAddress Die E-Mail-Adressinformationen des Absenders, für den die Außerkraftsetzung erstellt wird. Ja

ItemAttachment

Eine Nachricht, ein Kontakt oder ein Ereignis, das einer anderen Nachricht, einem anderen Ereignis oder einer anderen Aufgabe angefügt ist. Abgeleitet von der Anlagen Entität.

Typ: Microsoft.OutlookServices.ItemAttachment

Basistyp: Microsoft.OutlookServices.Attachment

Eigenschaft Typ Beschreibung Beschreibbar?
ContentType Zeichenfolge Der Inhaltstyp der Anlage. Ja
LastModifiedDateTime datetimeoffset Letzte Uhrzeit und letztes Datum der Änderung der Anlage. Nein
ID Zeichenfolge Die Anlagen-ID. Nein
Element Element Die angefügte Nachricht oder das angefügte Ereignis. Navigationseigenschaft. Ja
IsInline boolesch Legen Sie diesen auf „true“ fest, wenn es sich um eine Inlineanlage handelt, z. B. ein eingebettetes Bild innerhalb des Textkörpers des Elements. Ja
Name Zeichenfolge Der Anzeigename der Anlage. Ja
Größe Int32 Die Größe der Anlage in Byte. Ja

Erwähnung (Vorschau)

Dieses Feature ist derzeit nur in der Beta-Version verfügbar. Um mehr zu erfahren, wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365-REST-API-Referenz und wählen Sie beta.

Nachricht

Eine Nachricht in einem Postfachordner.

Typ: Microsoft.OutlookServices.Message

Eine Nachrichten-Sammlung gibt ein Array von Nachrichten in der Wert Eigenschaft der OData-Antwort zurück. Mit $count können Sie die Anzahl der Objekte in der Sammlung ermitteln: .../me/messages/$count

Unterstützte Aktionen finden Sie unter Nachrichtenoperationen.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar? Suchbar?
Anlagen Sammlung (Anlage) Die FileAttachment und ItemAttachment Anlagen der Nachricht. Navigationseigenschaft. Ja Nein Ja
BccRecipients Sammlung (Empfänger) Die Bcc-Empfänger der Nachricht. Ja Nein Ja
Text ItemBody Der Text der Nachricht. Ja Nein Standard
BodyPreview Zeichenfolge Die ersten 255 Zeichen des Nachrichtentextinhalts. Nein Nein Ja
Kategorien Sammlung (Zeichenfolge) Die Kategorien, die mit der Nachricht verknüpft sind. Ja Ja Ja
CcRecipients Sammlung (Empfänger) Die Cc-Empfänger der Nachricht. Ja Nein Ja
ChangeKey Zeichenfolge Die Version der Nachricht. Nein Nein Nein
ConversationId Zeichenfolge Die ID der Unterhaltung, zu der die E-Mail gehört. Nein Ja Nein
CreatedDateTime datetimeoffset Das Datum und die Uhrzeit, zu der die Nachricht erstellt wurde. Nein Ja Nein
Erweiterungen Sammlung (Erweiterung) Die Sammlung der für die Nachricht definierten Datenerweiterungen offenen Typs. Navigationseigenschaft. Nein Ja Nein
Von Empfänger Der Postfachbesitzer und der Absender der Nachricht. Ja Ja Ja
HasAttachments boolesch Gibt an, ob die Nachricht Anlagen enthält. Nein Ja Ja
ID Zeichenfolge Der eindeutige Bezeichner der Nachricht. Nein Nein Nein
Bedeutung Bedeutung Die Bedeutung der Nachricht: Niedrig = 0, Normal = 1, Hoch = 2. Ja Ja Ja
InferenceClassification InferenceClassificationType Die Klassifizierung dieser Nachricht für den Benutzer, basierend auf der abgeleiteten Relevanz oder Bedeutung oder auf einer expliziten Außerkraftsetzung. Ja Ja Ja
IsDeliveryReceiptRequested boolesch Zeigt an, ob für die Nachricht eine Lesebestätigung angefordert wird. Ja Ja Nein
IsDraft boolesch Gibt an, ob die Nachricht ein Entwurf ist. Eine Nachricht ist ein Entwurf, solange sie noch nicht gesendet wurde. Nein Ja Nein
IsRead boolesch Gibt an, ob die Nachricht gelesen wurde. Ja Ja Nein
IsReadReceiptRequested boolesch Zeigt an, ob für die Nachricht eine Lesebestätigung angefordert wird. Ja Ja Nein
LastModifiedDateTime datetimeoffset Das Datum und die Uhrzeit, zu der die Nachricht zuletzt geändert wurde. Nein Ja Nein
MultiValueExtendedProperties Eine Sammlung Eine Sammlung von erweiterten Mehrfachwert-Eigenschaften vom Typ MultiValueLegacyExtendedProperty. Dies ist eine Navigationseigenschaft.

Weitere Informationen über erweiterte Eigenschaften.
Ja Ja Nein
ParentFolderId Zeichenfolge Der eindeutige Bezeichner für den übergeordneten Ordner der Nachricht. Nein Nein Nein
ReceivedDateTime datetimeoffset Das Datum und die Uhrzeit, zu der die Nachricht erhalten wurde. Nein Ja Ja
ReplyTo Sammlung (Empfänger) Die E-Mail-Adressen, die beim Antworten verwendet werden sollen. Nein Nein Nein
Absender Empfänger Das Konto, das tatsächlich verwendet wird, um die Nachricht zu generieren. Ja Ja Standard
SingleValueExtendedProperties Eine Sammlung Eine Sammlung von erweiterten Einwert-Eigenschaften vom Typ SingleValueLegacyExtendedProperty. Dies ist eine Navigationseigenschaft.

Weitere Informationen über erweiterte Eigenschaften.
Ja Ja Nein
SentDateTime datetimeoffset Das Datum und die Uhrzeit, zu der die Nachricht gesendet wurde. Nein Ja Nein
Betreff Zeichenfolge Der Betreff der Nachricht. Ja Ja Standard
ToRecipients Sammlung (Empfänger) Die An Empfänger der Nachricht. Ja Nein Ja
UniqueBody ItemBody Der Text der Nachricht, der für die Konversation eindeutig ist. Nein Nein Nein
WebLink Zeichenfolge Die URL zum Öffnen der Nachricht in Outlook Web App.

Sie können am Ende der URL das Argument „ispopout“ anhängen, um zu ändern, wie die Nachricht angezeigt wird. Wenn „ispopout“ nicht vorhanden oder auf 1 festgelegt ist, wird die Nachricht in einem Popout-Fenster angezeigt. Wenn „ispopout“ auf 0 festgelegt ist, zeigt der Browser die Nachricht in Outlook Web App im Prüffensterbereich an.

Die Nachricht wird im Browser geöffnet, wenn Sie über Outlook Web App bei Ihrem Postfach angemeldet sind. Sie werden aufgefordert, sich anzumelden, wenn Sie noch nicht beim Browser angemeldet sind.

Auf diese URL kann von einem iFrame aus zugegriffen werden.
Nein Ja Nein

Entfernen von Skript aus der Text-Eigenschaft

Der Nachrichtentext kann entweder HTML oder Text sein. Wenn der Text HTML ist, wird standardmäßig jedes potentiell unsichere HTML (z. B. JavaScript), das in die Text Eigenschaft eingebettet ist, entfernt, bevor der Inhalt des Textes in einer REST-Antwort zurückgegeben wird.

Um den gesamten, ursprünglichen HTML-Inhalt zu erhalten, fügen Sie den folgenden HTTP-Anforderungs-Header ein:

Prefer: outlook.allow-unsafe-html

Einstellung der Von- und Absender-Eigenschaften

Beim Schreiben einer Nachricht stellen in den meisten Fällen die Von undAbsender Eigenschaften den gleichen angemeldeten Benutzer dar, es sei denn, eine der beiden Eigenschaften wird wie in den folgenden Szenarien beschrieben aktualisiert:

  • Die Von-Eigenschaft kann geändert werden, wenn der Exchange-Administrator SendAs-Rechte des Postfachs anderen Benutzern zugewiesen hat. Der Administrator kann dies tun, indem erPostfachberechtigungen des Postfachbesitzers im Azure-Verwaltungsportal auswählt oder dasExchange Admin Centeroder einWindows PowerShell Add-ADPermission-Cmdlet verwendet. Dann können Sie programmgesteuert die Von-Eigenschaft eines dieser Benutzer festlegen, die SendAs-Rechte für das Postfach haben.

  • Die Absender-Eigenschaft kann geändert werden, wenn der Exchange-Administrator eine oder mehrere Benutzer delegiert hat, um Nachrichten von diesem Postfach zu senden. Der Postfachbesitzer kann in Outlook delegieren. Wenn ein Stellvertreter eine Nachricht im Namen des Postfachbesitzers sendet, wird die Absender-Eigenschaft auf das Konto des Stellvertreters eingestellt und die Von-Eigenschaft bleibt als Postfachbesitzer erhalten. Programmgesteuert können Sie die Absender-Eigenschaft auf einen Benutzer einstellen, der die Stellvertreterrechte für dieses Postfach hat.

MessageRule (Vorschau)

Dieses Feature ist derzeit in der Beta-Version verfügbar. Um mehr zu erfahren, wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365-REST-API-Referenz und wählen Sie beta.

OutlookCategory (Vorschau)

Dieses Feature ist derzeit in der Beta-Version verfügbar. Um mehr zu erfahren, wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365-REST-API-Referenz und wählen Sie beta.

Foto

Typ: Microsoft.OutlookServices.Photo

Ein Foto, auf das von Exchange Online aus zugegriffen werden kann. Es sind Binärdaten, die nicht in base-64 kodiert sind.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
Höhe int Die Höhe des Fotos Nein Nein
ID Zeichenfolge Der eindeutige Bezeichner des Fotos. Nein Nein
Breite int Die Breite des Fotos. Nein Nein

ReferenceAttachment

Typ: Microsoft.OutlookServices.ReferenceAttachment

Basistyp: Microsoft.OutlookServices.Attachment

Eine Verknüpfung zu einer Datei oder einem Ordner, der einer Nachricht, einem Ereignis oder einer Aufgabe angefügt ist. Mögliche Speicherorte für die Datei oder den Ordner sind OneDrive, OneDrive for Business und DropBox. Abgeleitet von der Anlagen Entität.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
ContentType Zeichenfolge Der MIME-Typ der Anlage. Optional. Ja Nein
ID Zeichenfolge Der eindeutige Bezeichner der Verweisanlage. Nein Nein
IsFolder Boolesch Gibt an, ob die Anlage ein Verknüpfung zu einem Ordner ist. Muss auf wahr eingstellt werden, wenn SourceUrl eine Verknüpfung zu einem Ordner ist. Optional. Ja Nein
IsInline Boolesch true wenn die Anlage eine Inlineanlage ist, andernfalls false. Optional. Ja Ja
LastModifiedDateTime DateTimeOffset Datum und Uhrzeit der letzten Änderung der Anlage. Das Datum und die Uhrzeit verwenden das ISO 8601-Format und sind immer in UTC-Zeit angegeben. Zum Beispiel würde Mitternacht UTC am 1. Januar 2014 so aussehen: "2014-01-01T00:00:00Z''. Optional. Nein Ja
Name Zeichenfolge Der Anzeigename der Anlage. Dies muss nicht der aktuelle Dateiname sein. Erforderlich. Ja Ja
Berechtigung ReferenceAttachmentPermissions Gibt die Berechtigungen an, die für die Anlage vom Anbietertyp in ProviderType vergeben werden. Mögliche Werte sind: Other, View, Edit, AnonymousView, AnonymousEdit, OrganizationView und OrganizationEdit. Optional. Ja Nein
PreviewUrl Zeichenfolge Gilt nur für eine Verweisanlage eines Bildes - URL, um ein Vorschaubild zu erhalten. Verwenden Sie ThumbnailUrl und PreviewUrl nur, wenn SourceUrl eine Bilddatei identifiziert. Optional. Ja Nein
ProviderType ReferenceAttachmentProviders Der Typ des Anbieters, der eine Anlage dieses ContentType unterstützt. Mögliche Werte sind: Other, OneDriveBusiness, OneDriveConsumer und Dropbox. Optional. Ja Ja
Größe Int32 Die Länge der Anlage in Byte. Optional. Nein Nein
SourceUrl Zeichenfolge URL, um den Inhalt der Anlage abzurufen. Wenn dies eine URL zu einem Ordner ist, dann stellen Sie IsFolder auf wahr ein, damit der Ordner in Outlook oder in Outlook im Web korrekt angezeigt wird. Erforderlich. Ja Nein
ThumbnailUrl Zeichenfolge Gilt nur für eine Verweisanlage eines Bildes - URL, um ein Minaturansichtsbild zu erhalten. Verwenden Sie ThumbnailUrl und PreviewUrl nur, wenn SourceUrl eine Bilddatei identifiziert. Optional. Ja Nein

Aufgabe

Typ: Microsoft.OutlookServices.Task

Ein Outlook-Element, das eine Arbeitsaufgabe nachverfolgen kann. Sie können mit einer Aufgabe den Start, die fälligen und tatsächliche Fertigstellungstermine und -zeiten, ihren Fortschritt oder Status nachzuverfolgen, unabhängig davon, ob es sich um eine periodische Aufgabe handelt, die eine Erinnerung erfordert.

Für jede der folgenden datumsbezogenen Eigenschaften:

  • CompletedDateTime
  • CreatedDateTime
  • DueDateTime
  • LastModifiedDateTime
  • ReminderDateTime
  • StartDateTime

Wenn die Eigenschaft eingestellt ist, gibt die Aufgaben-REST-API sie standardmäßig in UTC in einer REST-Antwort zurück. Weitere Informationen zu Einstellung von StartDateTime und DueDateTime und Rückgabe von datumsbezogenen Eigenschaften in einer benutzerdefinierten Zeitzone.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
AssignedTo Zeichenfolge Der Name der Person, der die Aufgabe zugwiesen wurde. Nein Ja
Anlagen Sammlung (Anlage) Die Sammlung von FileAttachment- und ItemAttachment-Anlagen für die Aufgabe. Navigationseigenschaft. Nein Nein
Text ItemBody Der Aufgabentext, der typischerweise Informationen über die Aufgabe enthält. Beachten Sie, dass nur der HTML-Typ unterstützt wird. Ja Nein
Kategorien Sammlung (Zeichenfolge) Die der Aufgabe zugeordneten Kategorien. Ja Ja
ChangeKey Zeichenfolge Die Version der Aufgabe. Nein Nein
CompletedDateTime DateTimeTimeZone Das Datum in der angegebenen Zeitzone, an dem die Aufgabe beendet wurde. Ja Ja
CreatedDateTime DateTimeOffset Das Datum und die Uhrzeit der Erstellung der Aufgabe. Standardmäßig ist es in UTC. Sie können eine benutzerdefinierte Zeitzone im Anforderungsheader angeben. Nein Ja
DueDateTime DateTimeTimeZone Das Datum in der angegebenen Zeitzone, an dem die Aufgabe beendet werden soll. Ja Ja
HasAttachments boolesch Wird auf wahr eingestellt, wenn die Aufgabe Anlagen hat. Nein Ja
ID Zeichenfolge Der eindeutige Bezeichner der Aufgabe. Nein Nein
Bedeutung Bedeutung Die Bedeutung des Ereignisses: Low, Normal, High. Ja Ja
IsReminderOn boolesch Ist auf wahr gestellt, wenn Benachrichtigung eingestellt ist, den Benutzer an die Aufgabe zu erinnern. Ja Nein
LastModifiedDateTime DateTimeOffset Das Datum und die Uhrzeit der letzten Änderung der Aufgabe. Standardmäßig ist es in UTC. Sie können eine benutzerdefinierte Zeitzone im Anforderungsheader angeben. Nein Ja
Besitzer Zeichenfolge Der Name der Person, die die Aufgabe erstellt hat. Nein Ja
ParentFolderId Zeichenfolge Der eindeutige Bezeichner für den übergeordneten Ordner der Aufgabe. Nein Nein
Serie PatternedRecurrence Das Serienmuster für die Aufgabe. Ja Nein
ReminderDateTime DateTimeTimeZone Das Datum und die Uhrzeit für das Auftreten einer Erinnerungsbenachrichtigung der Aufgabe. Ja Nein
Vertraulichkeit Vertraulichkeit Gibt die Datenschutzebene für das Ereignis an: Normal, Personal, Private, Confidential. Ja Ja
StartDateTime DateTimeTimeZone Das Datum in der angegebenen Zeitzone, an dem die Aufgabe beginnen soll. Ja Ja
Status TaskStatus Zeigt den Status oder Fortschritt der Aufgabe an: NotStarted, InProgress, Completed, WaitingOnOthers, Deferred. Ja Ja
Betreff Zeichenfolge Eine kurze Beschreibung oder ein Titel der Aufgabe. Ja Ja

TaskFolder

Typ: Microsoft.OutlookServices.TaskFolder

Ein Ordner, der Aufgaben enthält. In Outlook enthält die Standardaufgabengruppe My Taskseinen Standardaufgabenordner, Tasks, für das Postfach des Benutzers. Sie können diese Standardaufgabengruppe und diesen Standardaufgabenordner nicht umbenennen oder löschen, aber Sie können weitere Aufgabengruppen und -ordner erstellen.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
ChangeKey Zeichenfolge Die Version des Aufgabenordners. Nein Nein
ID Zeichenfolge Der eindeutige Bezeichner des Aufgabenordners. Nein Nein
IsDefaultFolder Boolesch Wahr, wenn der Ordner der Standardaufgabenordner ist. Nein Ja
Name Zeichenfolge Der Name des Aufgabenordners. Ja Ja
ParentGroupKey Edm.Guid Der eindeutige GUID-Bezeichner für die übergeordnete Gruppe des Aufgabenordners. Nein Nein
Aufgaben Sammlung (Aufgabe) Die Aufgaben in dieser Aufgabenordner. Navigationseigenschaft. Nein Nein

TaskGroup

Typ: Microsoft.OutlookServices.TaskGroup

Eine Gruppe von Ordnern, die Aufgaben enthalten. In Outlook gibt es eine My Tasks-Standardaufgabengruppe, die Sie nicht umbenennen oder löschen können. Sie können jedoch weitere Aufgabengruppen erstellen.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
ChangeKey Zeichenfolge Die Version der Aufgabengruppe. Nein Nein
GroupKey Edm.Guid Der eindeutige GUID-Bezeichner für die Aufgabengruppe. Nein Nein
ID Zeichenfolge Der eindeutige Bezeichner der Aufgabengruppe. Nein Nein
IsDefaultGroup Boolesch Wahr, wenn die Aufgabengruppe die Standardaufgabengruppe ist. Nein Ja
Name Zeichenfolge Der Name der Aufgabengruppe. Ja Ja
TaskFolders Sammlung (TaskFolder) Die Aufgabenordner in dieser Aufgabengruppe. Navigationseigenschaft. Nein Nein

Benutzer

Ein Benutzer im System. Der Me-Endpunkt ist eine Abkürzung für die Angabe des aktuellen Benutzers über die SMTP-Adresse ( users/sadie@contoso.com).

Typ: Microsoft.OutlookServices.User

Eine Users Sammlung gibt ein Array von Benutzern in der Wert Eigenschaft der OData-Antwort zurück. Mit $count können Sie die Anzahl der Objekte in der Sammlung ermitteln: .../me/users/$count

Hinweis

Die Benutzer Entität enthält viele Eigenschaften und Beziehungen (Navigationseigenschaften), die häufig erweitert werden. Der folgende Abschnitt beschreibt nur eine Teilmenge. Aktuelle Informationen finden Sie in der Benutzer Definition in der entsprechenden Metadaten-Datei für Ihre Version.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
Alias Zeichenfolge Der Alias des Benutzers. Gewöhnlich die SMTP-Adresse des Benutzers. Ja Ja
Kalender Kalender Primärer Kalender des Benutzers. Navigationseigenschaft. Nein Nein
CalendarGroups Sammlung (CalendarGroup) Die Kalendergruppen des Benutzers. Navigationseigenschaft. Nein Nein
Kalender Sammlung (Kalender) Die Kalender des Benutzers. Navigationseigenschaft. Nein Nein
CalendarView Sammlung (Ereignis) Die Kalenderansicht für den Kalender. Navigationseigenschaft. Nein Nein
ContactFolders Sammlung (ContactFolder) Die Kontaktordner des Benutzers. Navigationseigenschaft. Nein Nein
Kontakte Sammlung (Kontakt) Die Kontakte des Benutzers. Navigationseigenschaft. Nein Nein
DisplayName Zeichenfolge Der Anzeigename des Benutzers. Ja Ja
Ereignisse Sammlung (Ereignis) Die Ereignisse des Benutzers. Standardmäßig werden Ereignisse unter dem Standardkalender angezeigt. Navigationseigenschaft. Nein Nein
ID Zeichenfolge Die eindeutige ID des Benutzers. Nein Nein
InferenceClassification InferenceClassification Relevanz-Klassifizierung von Nachrichten des Benutzers basierend auf expliziten Kennzeichnungen, die die abgeleitete Relevanz oder Bedeutung außer Kraft setzen. Navigationseigenschaft. Ja Ja
MailboxGuid GUID Die dem Postfach des Benutzers zugeordnete GUID. Nein Ja
MailboxSettings MailboxSettings Einstellungen für das primäre Postfach des angemeldeten Benutzers. Ja Nein
MailFolders Sammlung (MailFolder) Die Ordner in einem Postfach. Navigationseigenschaft. Nein Nein
Nachrichten Sammlung (Message) Die Nachrichten in einem Postfach oder Ordner. Navigationseigenschaft. Nein Nein
RootFolder MailFolder Der Stammordner des Postfachs des Benutzers. Navigationseigenschaft. Nein Nein

Komplexe Typen

Teilnehmer

Ein Teilnehmer eines Ereignisses.

Typ: Microsoft.OutlookServices.Recipient

Eigenschaft Typ Beschreibung
Status ResponseStatus Die Antwort (keine, akzeptiert, abgelehnt usw.) und die Zeit.
Typ AttendeeType Der Typ des Teilnehmers. Mögliche Werte sind: Required, Optional und Resource.

AttendeeAvailability

Typ und Verfügbarkeit eines Teilnehmers.

Typ: Microsoft.OutlookServices.AttendeeAvailability

Eigenschaft Typ Beschreibung
Teilnehmer AttendeeBase Der Typ des Teilnehmers. Unterschieden wird zwischen Personen und Ressourcen.
Verfügbarkeit FreeBusyStatus Der Verfügbarkeitsstatus des Teilnehmers.

AttendeeBase

Der Typ eines Teilnehmers.

Typ: Microsoft.OutlookServices.Recipient

Eigenschaft Typ Beschreibung
Typ AttendeeType Der Typ des Teilnehmers. Mögliche Werte sind: Required, Optional und Resource. Hinweis: Wenn der Teilnehmer eine Person ist, berücksichtigt FindMeetingTimes immer, dass die Person vom Required Typ ist.

AutomaticRepliesSetting

Konfigurationseinstellungen zum automatischen Benachrichtigen des Absenders bei eingehenden E-Mails mit einer Nachricht vom angemeldeten Benutzer. Beispiel: eine automatische Antwort, die darüber informiert, dass der angemeldete Benutzer zur Beantwortung von E-Mails nicht verfügbar ist.

Typ: Microsoft.OutlookServices.AutomaticRepliesSetting

Eigenschaft Typ Beschreibung
ExternalAudience ExternalAudienceScope Die Benutzergruppe außerhalb der Organisation des angemeldeten Benutzers, der ExternalReplyMessage erhält, wenn Status AlwaysEnabled oder Scheduled ist. Werte sind None = 0, ContactsOnly = 1 oder All = 2.
ExternalReplyMessage Zeichenfolge Die automatische Antwort an die angegebene externe Zielgruppe, wenn Status AlwaysEnabled oder Scheduled ist.
InternalReplyMessage Zeichenfolge Die automatische Antwort an die interne Zielgruppe in der Organisation des angemeldeten Benutzers, wenn Status AlwaysEnabled oder Scheduled ist.
ScheduledEndDateTime DateTimeTimeZone Datum und Uhrzeit, die zum Beenden der automatischen Antworten festgelegt werden, wenn Status auf Scheduled gesetzt ist. Sie können die Zeitzone mit dem Prefer: outlook.timezone-HTTP-Header im GET-Vorgang einstellen.
ScheduledStartDateTime DateTimeTimeZone Datum und Uhrzeit, die für den Beginn der automatischen Antworten festgelegt werden, wenn Status auf Scheduled gesetzt ist. Sie können die Zeitzone mit dem Prefer: outlook.timezone-HTTP-Header im GET-Vorgang einstellen.
Status AutomaticRepliesStatus Konfigurationsstatus für automatische Antworten: Disabled = 0, AlwaysEnabled = 1, Scheduled = 2.

DateTimeTimeZone

Beschreibt das Datum, die Uhrzeit und Zeitzone eines Zeitpunkts.

Eigenschaft Typ Beschreibung
DateTime DateTime Ein bestimmter Zeitpunkt in einer kombinierten Datums- und Uhrzeitsdarstellung (<date>T<time>) gemäß des ISO 8601Formats.
TimeZone Zeichenfolge Einer der folgenden Zeitzonennamen.

Die Eigenschaft TimeZone kann auf eine beliebige, von Windows unterstützte Zeitzone und auf einen der folgenden Zeitzonennamen eingestellt werden. Weitere Informationen finden Sie unter TimeZone.

Etc/GMT+12

Etc/GMT+11

Pazifik/Honolulu

Amerika/Anchorage

Amerika/Santa_Isabel

Amerika/Los_Angeles

Amerika/Phoenix

Amerika/Chihuahua

Amerika/Denver

Amerika/Guatemala

Amerika/Chicago

Amerika/Mexico_Stadt

Amerika/Regina

Amerika/Bogota

Amerika/New_York

Amerika/Indiana/Indianapolis

Amerika/Caracas

Amerika/Asuncion

Amerika/Halifax

Amerika/Cuiaba

Amerika/La_Paz

Amerika/Santiago

Amerika/St_Johns

Amerika/Sao_Paulo

Amerika/Argentinien/Buenos_Aires

Amerika/Cayenne

Amerika/Godthab

Amerika/Montevideo

Amerika/Bahia

Etc/GMT+2

Atlantik/Azoren

Atlantik/Kap_Verde

Afrika/Casablanca

Etc/GMT

Europa/London

Atlantik/Reykjavik

Europa/Berlin

Europa/Budapest

Europa/Paris

Europa/Warschau

Afrika/Lagos

Afrika/Windhoek

Europa/Bukarest

Asien/Beirut

Afrika/Kairo

Asien/Damaskus

Afrika/Johannesburg

Europa/Kiew

Europa/Istanbul

Asien/Jerusalem

Asien/Amman

Asien/Bagdad

Europa/Kaliningrad

Asien/Riad

Afrika/Nairobi

Asien/Teheran

Asien/Dubai

Asien/Baku

Europa/Moskau

Indisch/Mauritius

Asien/Tiflis

Asien/Eriwan

Asien/Kabul

Asien/Karatschi

Asien/Taschkent

Asien/Kolkata

Asien/Colombo

Asien/Katmandu

Asien/Almaty

Asien/Dhaka

Asien/Jekaterinburg

Asien/Rangun

Asien/Bangkok

Asien/Nowosibirsk

Asien/Shanghai

Asien/Krasnojarsk

Asien/Singapur

Australien/Perth

Asien/Taipeh

Asien/Ulan-Bator

Asien/Irkutsk

Asien/Tokio

Asien/Seoul

Australien/Adelaide

Australien/Darwin

Australien/Brisbane

Australien/Sydney

Pazifik/Port_Moresby

Australien/Hobart

Asien/Jakutsk

Pazifik/Guadalcanal

Asien/Wladiwostok

Pazifik/Auckland

Etc/GMT-12

Pazifik/Fidschi

Asien/Magadan

Pazifik/Tongatapu

Pazifik/Apia

Pazifik/Kiritimati

EmailAddress

Name und E-Mail-Adresse eines Kontakts oder eines Empfängers der Nachricht.

Typ: Microsoft.OutlookServices.EmailAddress

Eigenschaft Typ Beschreibung
Name Zeichenfolge Der Anzeigename der Person oder Entität.
Adresse Zeichenfolge Die E-Mail-Adresse der Person oder Entität.

GeoCoordinates

Die geografischen Koordinaten und die Rechteerweiterungen des Aufenthaltsortes.

Typ: Microsoft.OutlookServices.GeoCoordinates

Eigenschaft Typ Beschreibung
Höhe doppelt Die Höhe des Aufenthaltsortes.
Breitengrad doppelt Der Breitengrad des Aufenthaltsortes.
Längengrad doppelt Der Längengrad des Aufenthaltsortes.
Genauigkeit doppelt Die Genauigkeit des Sensors, der den Breiten- und Längengrad liefert.
AltitudeAccuracy doppelt Die Genauigkeit des Sensors, der die Höhe liefert.

ItemBody

Der Textinhalt einer Nachricht oder eines Ereignisses.

Type: Microsoft.OutlookServices.ItemBody

Eigenschaft Typ Beschreibung
ContentType BodyType Der Inhaltstyp: Text = 0, HTML = 1.
Inhalt Zeichenfolge Der Text- oder HTML-Inhalt.

LocaleInfo

Die Informationen über das Gebietsschema, einschließlich der bevorzugten Sprache und Land/Region, des angemeldeten Benutzers.

Typ: Microsoft.OutlookServices.LocaleInfo

Eigenschaft Typ Beschreibung
DisplayName Zeichenfolge Ein Name, der das Gebietsschema in seiner natürlichen Sprache darstellt, z. B. Englisch (USA).
Gebietsschema Zeichenfolge Die Gebietsschemadarstellung, einschließlich der bevorzugten Sprache und des Lands/der Region. Zum Beispiel "en-us". Die Sprachkomponente besteht entsprechend der Definitionen in ISO 639-1 aus 2 Buchstaben, und die Länderkomponente besteht entsprechend der Definitionen in ISO 3166-1-Alpha-2 aus 2 Buchstaben.

Aufenthaltsort

Der Aufenthaltsort eines Ereignisses.

Typ: Microsoft.OutlookServices.Location

Eigenschaft Typ Beschreibung
DisplayName Zeichenfolge Der Name, der mit dem Aufenthaltsort verknüpft ist.
Adresse PhysicalAddress Die physische Adresse des Aufenthaltsortes.
Koordinaten GeoCoordinates Die geografischen Koordinaten und die Rechteerweiterungen des Aufenthaltsortes.
LocationEmailAddress Zeichenfolge Optionale E-Mail-Adresse des Aufenthaltsortes.

LocationConstraint

Die vom Clienten definierten Bedingungen für den Aufenthaltsort einer Besprechung.

Typ: Microsoft.OutlookServices.LocationConstraint

Eigenschaft Typ Beschreibung
IsRequired boolesch Der Client fordert vom Dienst, in die Antwort einen Besprechungsort für die Besprechung aufzunehmen.
SuggestLocation boolesch Der Client fordert den Dienst auf, einen oder mehrere Besprechungsorte vorzuschlagen.
Aufenthaltsorte Sammlung (LocationConstraintItem) Ein oder mehrere Orte, die der Client für eine Besprechung anfordert.

LocationConstraintItem

Die von einem Clienten angegebenen Bedingungen für die Überprüfung der Verfügbarkeit eines jeden Aufenthaltsortes einer Besprechung und andere Informationen über den Aufenthaltsort.

Typ: Microsoft.OutlookServices.Location

Eigenschaft Typ Beschreibung
ResolveAvailability boolesch Wenn wahr eingestellt ist und die angegebene Ressource gebucht ist, sucht FindMeetingTimes nach einer anderen, freien Ressource. Wenn „falsch“ eingestellt ist und die angegebene Ressource beschäftigt ist, gibt FindMeetingTimes die Ressource mit dem höchsten Wert aus dem Cache des Benutzers zurück, ohne zu prüfen, ob diese Ressource frei ist. Der Standardwert ist „wahr“.

MailboxSettings

Einstellungen für das primäre Postfach des Benutzers.

Typ: Microsoft.OutlookServices.MailboxSettings

Eigenschaft Typ Beschreibung
AutomaticRepliesSetting AutomaticRepliesSetting Einstellungen, um das automatische Senden von Antworten auf eingehende Nachrichten zu konfigurieren.
TimeZone Zeichenfolge Die Standardzeitzone für das Postfach des Benutzers.
Sprache LocaleInfo Die Gebietsschema-Informationen des Benutzers, einschließlich der bevorzugten Sprache und Land/Region.

MeetingTimeSuggestion

Ein Besprechungsvorschlag mit Informationen wie dem Besprechungstermin, der Teilnahmewahrscheinlichkeit, der individuellen Verfügbarkeit des Teilnehmers und den verfügbaren Besprechungsorten.

Typ: Microsoft.OutlookServices.MeetingTimeSuggestion

Eigenschaft Typ Beschreibung
MeetingTimeSlot TimeSlot Ein für die Besprechung vorgeschlagenes Zeitfenster.
Zuverlässigkeit doppelt Ein Prozentwert, der angibt, wie hoch die Wahrscheinlichkeit ist, dass alle Teilnehmer teilnehmen können.
OrganizerAvailability FreeBusyStatus Die Verfügbarkeit des Besprechungsorganisators für diesen Besprechungsvorschlag: Free, Tentative, Busy, Oof, WorkingElsewhereund Unknown.
AttendeeAvailability Sammlung (AttendeeAvailability) Ein Array, das den Verfügbarkeitsstatus jedes Teilnehmers für den betreffenden Besprechungsvorschlag anzeigt.
Aufenthaltsorte Sammlung (Ort) Ein Array, das den Namen und den geografischen Ort jedes Besprechungsorts für den betreffenden Besprechungsvorschlag angibt
SuggestionReason Zeichenfolge Beschreibt die Gründe für den Vorschlag der Besprechungszeit.

Die Gewissheit einer Besprechung

Die Eigenschaft Gewissheit eines meetingTimeSuggestion liegt in einem Bereich von 0 % bis 100 %. Sie gibt an, wie wahrscheinlich es ist, dass alle Teilnehmer an der Besprechung teilnehmen können, und basiert auf dem Frei-/Beschäftigt-Status der einzelnen Teilnehmer:

  • Für jeden Teilnehmer gilt: Ist der Status für eine Besprechung „Frei“, liegt die Teilnahmewahrscheinlichkeit bei 100 %. Beim Status „Unbekannt“ liegt sie bei 49 %, beim Status „Gebucht“ bei 0 %.
  • Zur Berechnung der Gewissheit eines Kandidaten für einen Besprechungstermin wird der Mittelwert aus den individuellen Teilnahmewahrscheinlichkeiten aller Besprechungsteilnehmer für die betreffende Besprechung gebildet.
  • Sie können den Parameter MinimumAttendeePercentage optional für FindMeetingTimes verwenden, um nur ein Besprechungszeitfenster mit mindestens einem bestimmten Konfidenzniveau anzugeben. Beispielsweise können Sie eine MinimumAttendeePercentage von 80 % angeben, wenn Sie nur Vorschläge wünschen, die eine Wahrscheinlichkeit von 80 % oder mehr haben, dass alle Teilnehmer teilnehmen. Wenn Sie MinimumAttendeePercentage nicht angeben, nimmt FindMeetingTimes einen Wert von 50 % an.
  • Wenn es mehrere Kandidaten für den Besprechungstermin gibt, ordnet die FindMeetingTimes-Aktion die Kandidaten zunächst nach ihrem berechneten Konfidenzwert, beginnend mit dem Kandidaten mit dem höchsten Wert. Wenn es Kandidaten mit dem gleichen Konfidenzwert gibt, ordnet die Aktion diese Kandidaten chronologisch.

Hier ein Beispiel für ein Besprechungszeitfenster für drei Teilnehmer mit folgendem Frei-/Beschäftigt-Status:

Teilnehmer Frei-/Gebucht-Status Teilnahmewahrscheinlichkeit in %
Dana Frei 100 %
John Unbekannt 49 %
Fanny Gebucht 0 %

Die Konfidenz des Besprechungs-Zeitfensters (durchschnittliche Teilnahmewahrscheinlichkeit) liegt hier bei (100 % + 49 % + 0 %) ÷ 3 = 49,66 %.

Wenn Sie eine MinimumAttendeePercentage von 80 % in einer Operation des Typs FindMeetingTimes festlegen, wird die Operation dieses Zeitfenster nicht in der Antwort vorschlagen, da 49,66 % < 80 % ist.

MeetingTimeSuggestionsResult

Dieser Ressourcentyp listet eine Sammlung von Besprechungsvorschlägen auf, sofern Vorschläge zurückgegeben werden, oder den Grund, aus dem keine Vorschläge zurückgegeben werden.

Typ: Microsoft.OutlookServices.MeetingTimeSuggestionsResult

Eigenschaft Typ Beschreibung
MeetingTimeSuggestions Sammlung (MeetingTimeSuggestion) Ein Array von Besprechungsvorschlägen.
EmptySuggestionsReason Zeichenfolge Ein Grund, aus dem keine Besprechungsvorschläge zurückgegeben wurden. Mögliche Werte sind: AttendeesUnavailable, LocationsUnavailable, OrganizerUnavailable, AttendeesUnavailableOrUnknown und Unknown.

Gründe dafür, dass keine Besprechungsvorschläge zurückgegeben werden

Die Eigenschaft EmptySuggestionsReason gibt einen der folgenden Gründe an, warum die FindMeetingTimes Aktion keine Besprechungsvorschläge zurückgibt. Die Eigenschaft ist eine leere Zeichenfolge, wenn FindMeetingTimes alle Besprechungsvorschläge zurückgibt.

Wert Gründe
AttendeesUnavailable Die Verfügbarkeit aller Teilnehmer ist bekannt, die Zahl der verfügbaren Teilnehmer liegt jedoch unter dem Schwellenwert für die Besprechungskonfidenz. Dieser ist standardmäßig auf 50 % festgelegt.
AttendeesUnavailableOrUnknown Die Verfügbarkeit einiger oder aller Teilnehmer ist unbekannt, sodass die Besprechungskonfidenz unter dem definierten Schwellenwert liegt. Dieser ist standardmäßig auf 50 % gesetzt. Die Verfügbarkeit eines Teilnehmers kann unbekannt sein, wenn der Teilnehmer nicht zur Organisation gehört oder ein Fehler beim Abruf der Frei-/Gebucht-Informationen auftritt.
LocationsUnavailable Die Eigenschaft isRequired des Parameters LocationConstraint ist als obligatorisch festgelegt, aber es sind während der berechneten Zeitfenster keine Orte verfügbar.
OrganizerUnavailable Der Parameter IsOrganizerOptional ist auf falsch eingestellt, der Organisator ist aber während des angefragten Zeitfensters nicht verfügbar.
Unbekannt Der Grund, aus dem keine Besprechungsvorschläge zurückgegeben wurden, ist nicht bekannt.

PatternedRecurrence

Serienmuster und -bereich.

Typ: Microsoft.OutlookServices.PatternedRecurrence

Eigenschaft Typ Beschreibung
Muster RecurrencePattern Die Häufigkeit eines Ereignisses.
Spanne RecurrenceRange Die Dauer eines Ereignisses.

PhysicalAddress

Die physische Adresse eines Kontakts.

Typ: Microsoft.OutlookServices.PhysicalAddress

Eigenschaft Typ Beschreibung
Straße Zeichenfolge Die Straße.
Stadt Zeichenfolge Der Ort.
Land Zeichenfolge Das Land.
CountryOrRegion Zeichenfolge Land oder Region. Ein frei formatierbarer Zeichenfolgenwert, z. B. Vereinigte Staaten.
PostalCode Zeichenfolge Die Postleitzahl.

Empfänger

Stellt Informationen zu einem Benutzer am sendenden oder empfangenden Ende eines Ereignisses oder einer Nachricht dar.

Typ: Microsoft.OutlookServices.Recipient

Eigenschaft Typ Beschreibung
EmailAddress EmailAddress Die E-Mail-Adresse des Empfängers.

RecurrencePattern

Die Häufigkeit eines Ereignisses.

Typ: Microsoft.OutlookServices.RecurrencePattern

Eigenschaft Typ Beschreibung
Typ RecurrencePatternType Der Serienmustertyp: Täglich = 0, Wöchentlich = 1, AbsolutMonthly = 2, RelativMonthly = 3, AbsolutYearly = 4, RelativYearly = 5.
Musterregeln:
- AbsoluteYearly. Muss den Monat und DayOfMonth des Ereignisses festlegen
- RelativeYearly. Muss den Monat, DaysOfWeek, und FirstDayOfWeek-Index festlegen
- AbsoluteMonthly. Muss DayOfMonth festlegen
- RelativeMonthly. Muss den FirstDayOfWeek-Index und den RecurrenceRange.NumberOfOccurrences festlegen
- Weekly. Muss dieDaysOfWeek und den FirstDayOfWeek festlegen
- Daily. Keine zusätzlichen Musterinformationen benötigt.
Intervall Int32 Die Anzahl von Einheiten eines bestimmten Serientyps zwischen Vorkommen.
DayOfMonth Int32 Der Tag des Monats, an dem das Element auftritt.
Monat Int32 Der Monat, an dem das Element auftritt. Dies ist eine Zahl zwischen 1 und 12.
DaysOfWeek Sammlung (DayOfWeek) Eine Sammlung von Wochentagen: Sonntag = 0, Montag = 1, Dienstag = 2, Mittwoch = 3, Donnerstag = 4, Freitag = 5, Samstag = 6.
FirstDayOfWeek DayOfWeek Der Wochentag: Sonntag = 0, Montag = 1, Dienstag = 2, Mittwoch = 3, Donnerstag = 4, Freitag = 5, Samstag = 6.
Index WeekIndex Der Wochenindex: Erste = 0, zweite = 1, dritte = 2, vierte = 3, letzte = 4.

RecurrenceRange

Die Dauer eines Ereignisses.

Typ: Microsoft.OutlookServices.RecurrenceRange

Eigenschaft Typ Beschreibung
Typ RecurrenceRangeType Der Serienbereich: EndDate = 0, NoEnd = 1, Nummeriert = 2.
StartDate datetimeoffset Erforderlich: Das Startdatum der Serie.
EndDate datetimeoffset Benötigt für datumsgebundene Muster: Das Enddatum der Serie. Muss nach dem Startdatum sein.
NumberOfOccurrences Int32 Benötigt für nummerierte Muster: Wie oft soll das Ereignis wiederholt werden.

ResponseStatus

Der Antwortstatus einer Besprechungsanfrage.

Typ: Microsoft.OutlookServices.ResponseStatus

Eigenschaft Typ Beschreibung
Antwort ResponseType Der Antworttyp: None, Organizer, TentativelyAccepted, Accepted, Declined, NotResponded.
Zeit datetimeoffset Datum und Uhrzeit, an dem bzw. der die Antwort zurückgegeben wurde.

TimeConstraint

Schränkt Vorschläge für Besprechungstermine entsprechend der angegebenen Art der Aktivität und der offenen Zeitfenster auf bestimmte Stunden und Tage der Woche ein.

Typ: Microsoft.OutlookServices.TimeConstraint

Eigenschaft Typ Beschreibung
ActivityDomain ActivityDomain Optional, die Art der Aktivität: Work, Personal, Unrestricted oder Unknown.
Zeitfenster Sammlung (TimeSlot) Ein Array von Zeiträumen.

TimeSlot

Ein Zeitfraum.

Typ: Microsoft.OutlookServices.TimeSlot

Eigenschaft Typ Beschreibung
Start DateTimeTimeZone Die Zeit, in der ein Zeitraum beginnt.
Ende DateTimeTimeZone Die Zeit, in der ein Zeitraum endet.

Enumerationen

ActivityDomain

Die Art einer Aktivität.

Unterstützte Werte:

  • Arbeit
  • Persönlich
  • Uneingeschränkt
  • Unbekannt

AutomaticRepliesStatus

Der Konfigurationsstatus für das automatische Senden einer Antwort, wenn das Postfach des Benutzers eine Nachricht erhält.

Unterstützte Werte:

  • AlwaysEnabled
  • Deaktiviert
  • Geplant

DayOfWeek

Die Gruppe der Wochentage.

Unterstützte Werte:

  • Sonntag
  • Montag
  • Dienstag
  • Mittwoch
  • Donnerstag
  • Freitag
  • Samstag

ExternalAudienceScope

Die Menge der externen Benutzergruppen, an die die ExternalReplyMessage gesendet werden soll.

Unterstützte Werte:

  • Alle
  • ContactsOnly
  • Keine

FreeBusyStatus

Gibt den Verfügbarkeitsstatus eines Teilnehmers für eine Besprechung an.

Unterstützte Werte:

  • Beschäftigt
  • Frei
  • Abwesend
  • Vorläufig
  • Unbekannt
  • WorkingElsewhere

InferenceClassificationType

Stellt die abgeleitete Relevanz einer Nachricht für einen Benutzer dar, auf die er sich konzentrieren kann.

Unterstützte Werte:

  • Relevant
  • Sonstiges

ReferenceAttachmentPermissions

Zugriffsberechtigungen für die Datei oder den Ordner der Verweis-Anlage.

Unterstützte Werte:

  • Sonstiges
  • Ansicht
  • Bearbeiten
  • AnonymousView
  • AnonymousEdit
  • OrganizationView
  • OrganizationEdit

ReferenceAttachmentProviders

Mögliche Dateispeicheranbieter für Verweisanlagen.

Unterstützte Werte:

  • Dropbox
  • OneDriveBusiness
  • OneDriveConsumer
  • Sonstiges

Vertraulichkeit

Zeigt die Datenschutzebene an.

Unterstützte Werte:

  • Standard
  • Persönlich
  • Privat
  • Vertraulich

TaskStatus

Gibt den Status oder Fortschritt einer Aufgabe an.

Unterstützte Werte:

  • Abgeschlossen
  • Zurückgestellt
  • InProgress
  • NotStarted
  • WaitingOnOthers

OData-Abfrageparameter

Sie können die Standard-Abfrageparameter OData v4.0 verwenden, um Datenanforderungen zu filtern und die Seitenergebnisse zu sortieren und anzuzeigen, wenn Sie mit den Mail-, Kalender- und Kontakt-APIs arbeiten. Achten Sie bei der Angabe von Abfrageparametern darauf, dass Zeichen, die für spezielle Bedeutungen in einem URI reserviert sind, entsprechend kodiert werden.

  • $search nach bestimmten Kriterien suchen

  • $filter nach bestimmten Kriterien filtern

  • $select um bestimmte Eigenschaften anzufordern

  • $orderby um Ergebnisse zu sortieren

  • $top und $skip zur Seite Ergebnisse

  • $expand um Nachrichtenanlagen und Ereignisanlagen zu erweitern

  • $count um die Anzahl der Entitäten in einer Sammlung zu ermitteln. Dieser Parameter gehört in den URL-Pfad: .../me/calendars/$count

Die Abfrage mit der Mail-, Kalender- und Kontakt-API verwendet immer einen flachen Bereich. Es werden nur Elemente innerhalb des aktuellen Ordners zurückgegeben. Tiefe Suchen werden nicht unterstützt.

Suchanforderungen

Mit dem Parameter $search können Sie die Ergebnisse einer Anforderungen auf die Nachrichten beschränken, die einem Suchbegriff entsprechen. Such-Zeichenfolgen werden mithilfe von Advanced Query Syntax (AQS) ausgedrückt. Die Ergebnisse werden nach Datum und Uhrzeit sortiert, an dem bzw. zu der die Nachricht gesendet wurde.

Hinweis

Sie können bis zu 250 Ergebnisse aus einer $search Anforderung erhalten. Sie können $search nur für Nachrichten verwenden. Die Suche nach Kontakten und Kalenderereignissen wird nicht unterstützt.

Sie können $filter oder $orderby in einer Suchanforderung nicht verwenden. In diesem Fall erhalten Sie eine Fehlermeldung wie diese.

    {
      "error":
      {
        "code":"ErrorInvalidUrlQuery",
        "message":"The query parameter 'OrderBy' is invalid."
      }
    }
Eigenschaft Beschreibung
Anlage Sucht nach der angegebenen Anlage nach Titel.
Bcc Sucht das Bcc-Feld.
Text oder Inhalt Sucht das Text-Feld. Wird nur bei der Standardsuche unterstützt.
Kategorie Sucht das Kategorie-Feld.
Cc Sucht das Cc-Feld.
Von Sucht das Von-Feld.
Hat Sucht das HasAttachments-Feld.
Teilnehmer Sucht die An, Ccund Bcc-Felder.
Empfangen Sucht das Empfangen-Feld nach einem bestimmten Datum, ausgedrückt als MM/DD/YYYYY.
Absender Sucht das Absender-Feld.
Betreff Sucht das Betreff-Feld.
An Sucht das An Feld.

Sie suchen allgemeine Felder mit dem Parameter $search ohne Angabe einer Eigenschaft. Eine Standardsuche durchsucht die Eigenschaften Text, Absenderund Betreff. Die folgende Suche gibt alle Nachrichten im Posteingang zurück, die "Pizza" in einer der drei Standardeigenschaften enthalten.

Schauen wir uns einige Beispiele an. Damit sie leichter lesbar werden, sind die URLs in den Beispielen nicht URL-codiert; wenn Sie diese Beispiele ausprobieren, stellen Sie jedoch sicher, dass sie URL-codiert sind, bevor Sie sie an den Server senden.

Sie können diese Anforderung verwenden, um alle Nachrichten im Posteingang zu erhalten, die das Wort "Pizza" in der Eigenschaft Von, Betreff oder Text enthalten.

GET https://outlook.office.com/api/v2.0/me/messages?$search="pizza"

Sie können diese Anforderung verwenden, um alle Nachrichten im Posteingang zu erhalten, die das Wort "Pizza" in der Eigenschaft Betreff enthalten.

GET https://outlook.office.com/api/v2.0/me/messages?$search="subject:pizza"

Sie können diese Anforderung verwenden, um alle Nachrichten im Posteingang zu erhalten, die von einer bestimmten Person gesendet wurden.

GET https://outlook.office.com/api/v2.0/me/messages?$search="from:help@contoso.com"

Die obigen Beispiele enthielten keine URL-Codierung, hier sind die gleichen Beispiele URL-codiert und bereit, an Ihren Server zu senden:

GET https://outlook.office.com/api/v2.0/me/messages?$search=%22pizza%22
GET https://outlook.office.com/api/v2.0/me/messages?$search=%22subject:pizza%22
GET https://outlook.office.com/api/v2.0/me/messages?$search=%22from:help@contoso.com%22

Filteranforderungen

Mit dem Abfrageparameter $filter können Sie Suchkriterien mithilfe der folgenden Filteroperatoren angeben.

Nicht alle Eigenschaften unterstützen das Filtern. Nur die mit "Ja" gekennzeichneten Ressourceneigenschaften im Feld "Filterbar?" Spalte in den entsprechenden Tabellen oben können verwendet werden. Wenn eine Eigenschaft nicht filterbar ist, erhalten Sie eine Fehlermeldung wie diese, die zurückgegeben wird, wenn Sie versuchen, auf die Eigenschaft ChangeKey zu filtern:

    {
      "error":
      {
        "code":"ErrorInvalidProperty",
        "message":"The property 'ChangeKey' does not support filtering."
      }
    }

Wenn Sie eine Filtermethode verwenden, die nicht unterstützt wird, erhalten Sie eine Fehlermeldung wie diese, die zurückgegeben wird, wenn die Filtermethode startswith für die Eigenschaft Betreff verwendet wird:

    {
      "error":
      {
        "code":"ErrorInvalidUrlQueryFilter",
        "message":"'contains' and 'startswith' are not supported for filtering.  Use Search instead."
      }
    }
Operator Typ Beispiel
und Logisch und (zum Vereinen mehrerer Kriterien) TotalCount gt 0 and ChildFolderCount eq 0
oder Logisch oder (zum Vereinen mehrerer Kriterien) TotalCount gt 0 or ChildFolderCount eq 0
eq Gleich IsRead eq false
ne Ist nicht gleich Importance ne Microsoft.Exchange.Services.OData.Model.Importance'High'
gt Größer als ReceivedDateTime gt 2014-09-01T00:00:00Z
ge Größer als oder gleich LastModifiedDateTime ge 2014-09-01T00:00:00Z
lt Kleiner als ReceivedDateTime lt 2014-09-01T00:00:00Z
le Kleiner als oder gleich LastModifiedDateTime le 2014-09-01T00:00:00Z

Verwenden Sie einfache Anführungszeichen ('), um einen beliebigen Zeichenfolgenwert im Filterkriterium abzugrenzen. Verwenden Sie %27, um das einfache Anführungszeichen zu codieren. Die Zeichenfolge selbst unterscheidet nicht zwischen Groß- und Kleinschreibung.

Schauen wir uns einige Beispiele an. Damit sie leichter lesbar werden, sind die URLs in den Beispielen nicht URL-codiert; wenn Sie diese Beispiele ausprobieren, stellen Sie jedoch sicher, dass sie URL-codiert sind, bevor Sie sie an den Server senden.

Sie können nach der Eigenschaft Start filtern, um alle Ereignisse im Standardkalender des Benutzers zu erhalten, die an oder nach einem bestimmten Datum beginnen.

GET https://outlook.office.com/api/v2.0/me/events?$filter=Start/DateTime ge '2016-04-01T08:00'

Sie können nach der Eigenschaft Betreff filtern, um alle Ereignisse im Kalender des Benutzers mit einem bestimmten Thema zu erhalten.

GET https://outlook.office.com/api/v2.0/me/events?$filter=Subject eq 'Mega Charity Bash'

Sie können nach der Eigenschaft IsRead filtern, um alle ungelesenen Nachrichten im Posteingang zu erhalten.

GET https://outlook.office.com/api/v2.0/me/messages?$filter=IsRead eq false

Sie können nach der Eigenschaft HasAttachments filtern, um alle Nachrichten im Posteingang mit Anlagen zu erhalten.

GET https://outlook.office.com/api/v2.0/me/messages?$filter=HasAttachments eq true

Sie können nach der Eigenschaft ReceivedDateTime filtern, um alle Nachrichten im Posteingang seit dem 1. September 2014 zu erhalten.

GET https://outlook.office.com/api/v2.0/me/messages?$filter=ReceivedDateTime ge 2014-09-01

Sie können nach der Eigenschaft Absender filtern, um alle Nachrichten im Posteingang von "hr@contoso.com" zu erhalten.

GET https://outlook.office.com/api/v2.0/me/messages?$filter=From/EmailAddress/Address eq 'hr@contoso.com'

Die obigen Beispiele enthielten keine URL-Codierung, hier sind die gleichen Beispiele URL-codiert und bereit, an Ihren Server zu senden:

GET https://outlook.office.com/api/v2.0/me/events?$filter=Start/DateTime%20ge%20%272016-04-01T08:00%27
GET https://outlook.office.com/api/v2.0/me/events?$filter=Subject%20eq%20%27Mega%20Charity%20Bash%27
GET https://outlook.office.com/api/v2.0/me/messages?$filter=IsRead%20eq%20false
GET https://outlook.office.com/api/v2.0/me/messages?$filter=HasAttachments%20eq%20true
GET https://outlook.office.com/api/v2.0/me/messages?$filter=ReceivedDateTime%20ge%202014-09-01
GET https://outlook.office.com/api/v2.0/me/messages?$filter=From/EmailAddress/Address%20eq%20%27hr@contoso.com%27

Bestimmte Eigenschaften auswählen, die zurückgegeben werden sollen

Mit dem Abfrageparameter $select können Sie nur die Eigenschaften angeben, die Ihre App benötigt.

Hinweis

Wenn Sie Mail-, Kalender- und Kontaktelemente erhalten, verwenden Sie immer$select, um nicht benötigte Eigenschaften in der Antwort-Nutzlast auszuschließen und um eine vernünftige Appleistung zu erhalten. Wenn Sie keinen Parameter $select angeben, werden alle Eigenschaften für die Elemente zurückgegeben.

Das folgende Beispiel liefert die EigenschaftenBetreff, Absender und ReceivedDateTime für alle Nachrichten im Posteingang.

GET https://outlook.office.com/api/v2.0/me/messages?$select=Subject,Sender,ReceivedDateTime

Ergebnisse sortieren

Sie können die Ergebnisse mit dem Abfrageparameter $orderby sortieren. Legen Sie den Wert dieses Parameters auf einen Eigenschaftsnamen fest und geben Sie optional aufsteigend (Standard) oder absteigend an. Denken Sie daran, dass Sie den Abfrageparameter $orderby mit $search nicht verwenden können.

Das folgende Beispiel ohne URL-Codierung sortiert alle Nachrichten im Posteingang nach der Eigenschaft ReceivedDateTime in absteigender Reihenfolge.

GET https://outlook.office.com/api/v2.0/me/messages?$orderby=ReceivedDateTime desc

Das gleiche Beispiel mit URL-Codierung:

GET https://outlook.office.com/api/v2.0/me/messages?$orderby=ReceivedDateTime%20desc

Seitenergebnisse

Standardmäßig gibt eine GET-Anforderung für eineNachrichten- oder ChildFolders-Eigenschaft, eine Sammlung oder für eineCalendarViewzehn Einträge zurück (maximal 50). Sie können dieses Verhalten ändern, indem Sie den Abfrageparameter $top verwenden, um eine maximale Anzahl einzustellen. Das folgende Beispiel liefert die ersten fünf Nachrichten im Posteingang.

GET https://outlook.office.com/api/v2.0/me/messages?$top=5

Wenn sich mehr als fünf Nachrichten im Posteingang befinden, enthält die Antwort eine odata.nextLink Eigenschaft. Die Anwesenheit dieser Eigenschaft zeigt an, dass mehr Elemente auf dem Server verfügbar sind. Der Wert dieser Eigenschaft ist eine URI, die zum Abrufen der nächsten fünf Elemente verwendet werden kann.

GET https://outlook.office.com/api/v2.0/me/messages?$top=5&$skip=5

Das Paging wird durch die Verwendung des Parameters $top zur Angabe einer Seitengröße und des Parameters $skip als Vielfaches der Seitengröße erreicht. Durch Erhöhen des Parameters $skip um die Seitengröße können Sie die nächste Seite in der Ergebnismenge anfordern.

Entitäten in einer Sammlung zählen

Sie können die Anzahl der Entitäten in einer Sammlung mit dem Parameter $count ermitteln. Sie können die Zählanforderung auch filtern.

Dieses Beispiel liefert die Anzahl der Nachrichten im Posteingang.

GET https://outlook.office.com/api/v2.0/me/messages/$count

Und dieses Beispiel ohne URL-Codierung liefert die Anzahl der ungelesenen Nachrichten im Posteingang.

GET https://outlook.office.com/api/v2.0/me/messages/$count?$filter=IsRead eq false

Das gleiche Beispiel mit URL-Codierung.

GET https://outlook.office.com/api/v2.0/me/messages/$count?$filter=IsRead%20eq%20false

Zusammengefasst

Sie können Parameter vereinen, um komplexe Abfragen zu erstellen. Das folgende Beispiel verfeinert eine Abfrage der Nachrichten im Posteingang wie folgt:

  • Gibt nur Elemente, deren Bedeutung auf Hoch eingestellt ist, zurück.

  • Gibt nur die Eigenschaften Betreff, Absenderund ReceivedDateTime zurück.

  • Gibt nur die ersten fünf Nachrichten zurück.

Hinweis

Die URL-Codierung wird nicht verwendet, und Zeilenumbrüche wurden hinzugefügt, um das Lesen des Beispiels zu vereinfachen.

https://outlook.office.com/api/v2.0/me/messages?
    $filter=Importance eq 'High'
    &$select=Subject,Sender,ReceivedDateTime
    &$top=5

Wenn Sie $filter angeben, leitet der Server eine Sortierreihenfolge für die Ergebnisse ab. Wenn Sie$filter und $orderby verwenden, müssen die Eigenschaften in $filter zuerst im $orderby vor allen anderen Eigenschaften aufgeführt werden und sie müssen in der Reihenfolge aufgelistet werden, in der sie im Parameter $filter erscheinen.

Das folgende Beispiel zeigt eine Abfrage, die nach den Eigenschaften Betreff und Wichtigkeit gefiltert und dann nach den Eigenschaften Betreff, Wichtigkeit und Absender sortiert wird.

https://outlook.office.com/api/v2.0/me/messages?
    $filter=Subject eq 'Good Times' AND Importance eq 'High'&
    $orderby=Subject,Importance,Sender

Hier sind die gleichen Beispiele mit URL-Codierung und ohne Zeilenumbrüche.

https://outlook.office.com/api/v2.0/me/messages?$filter=Importance%20eq%20%27High%27&select=Subject,Sender,ReceivedDateTime&$top=5

https://outlook.office.com/api/v2.0/me/messages?$filter=Subject%20eq%20%27Good%20Times%27%20AND%20Importance%20eq%20%27High%27&$orderby=Subject,Importance,Sender

Siehe auch