Outlook-Aufgaben-REST-API-Verweis (Version 2.0)

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

Mit der Outlook-Aufgabe - REST API können Sie die Aufgaben eines Benutzers, die durch Azure Active Directory in Office 365 gesichert sind, erstellen, lesen, synchronisieren, aktualisieren und löschen. Das Benutzerkonto kann in Office 365 oder in einem Microsoft-Konto (Hotmail.com, Live.com, MSN.com, Outlook.com und Passport.com) sein.

Hinweis

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

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

Übersicht

Sie können eine Aufgabe in Outlook verwenden, um eine Arbeitsaufgabe nachzuverfolgen. Sie können ihren Beginn, ihre fälligen oder tatsächlichen Fertigstellungstermine, den Fortschritt oder den Status notieren, oder ob sich die Aufgabe wiederholt oder eine Erinnerung benötigt wird.

Aufgaben werden in den Aufgabenordnern organisiert, die wiederum in Aufgabengruppenorganisiert sind. Jedes Postfach hat einen Standardaufgabenordner (mit der Eigenschaft Name Tasks) und eine Standardaufgabengruppe (Die EigenschaftName ist My Tasks).

Verwenden der Aufgaben-REST-API

Authentifizierung

Wie andere Outlook REST-API sollten Sie für jede Anforderung an die Aufgaben-REST-API ein gültiges Zugriffstoken einschließen. Sie müssen Ihre App registriert und identifiziert haben und die entsprechende Autorisierung erhalten haben, ein Zugriffstoken abzurufen.

Sie können mehr über einige optimierte Registrierungs- und Autorisierungsoptionen für Sie herausfinden. Beachten Sie dies, wenn Sie mit den spezifischen Operationen in der Aufgaben-REST-API fortfahren.

Version von API

Diese API wurde von der Vorschauversion auf den Status Allgemeine Verfügbarkeit (GA) befördert. Sie wird in den v2.0 und Beta-Versionen der Outlook-REST-API unterstützt.

Ziel-Benutzer

Die Aufgaben-API-Anforderungen werden immer im Namen des angemeldeten Benutzers ausgeführt.

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

URL-Parameter

Die Beispiele in diesem Artikel verwenden die folgenden Platzhalter als Parameter für REST-Anforderungs-URLs.

Parameter Typ Beschreibung
URL-Parameter
attachment_id Zeichenfolge Die numerische ID einer Anlage, die im Postfach des Benutzers eindeutig ist.
folder_id Zeichenfolge Der bekannte Tasks Standardordnername oder eine numerische ID eines Aufgabenordners ist eindeutig im Postfach des Benutzers.
group_id Zeichenfolge Die numerische ID einer Aufgabengruppe, die im Postfach des Benutzers eindeutig ist.
task_id Zeichenfolge Die numerische Aufgaben-ID, die im Postfach des Benutzers eindeutig ist.

Angabe der Eigenschaften StartDateTime und DueDateTime

Beim Erstellen einer Aufgabe:

  • StartDateTime und DueDateTime sind optional, aber für die Einstellung StartDateTime muss die Einstellung DueDateTime auf das gleiche oder ein späteres Datum eingestellt sein.
  • Wenn Sie nur StartDateTime einstellen, wird DueDateTime automatisch auf den gleichen Wert wie StartDateTime eingestellt.
  • Wenn Sie DueDateTime auf null einstellen, dann wird StartDateTime ebenfalls automatisch auf null eingestellt.

Wenn Sie StartDateTime oder DueDateTime beim Erstellen oder Aktualisieren einer Aufgabe einstellen:

  • Geben Sie das Datum und die Zeitzone an.
  • Geben Sie in diesen Eigenschaften keine bestimmte Zeit an, da die Methode POST (oder PATCH) diese immer ignoriert und in der angegebenen Zeitzone von Mitternacht ausgeht.
  • Standardmäßig konvertiert die Methode POST (oder PATCH) den Wert in UTC und gibt in der Antwort einen UTC-Wert zurück.

Wenn Sie beispielsweise den 26. April in der Eastern Normalzeit (EST) in StartDateTimeangeben:

  "StartDateTime": {
      "DateTime": "2016-04-26T09:00:00",
      "TimeZone": "Eastern Standard Time"
  }

POST (oder PATCH) ignoriert den Zeitanteil, wandelt den 26. April Mitternacht in EST in UTC um und gibt diesen UTC-Wert in der Antwort zurück:

  "StartDateTime": {
    "DateTime": "2016-04-26T04:00:00.0000000",
    "TimeZone": "UTC"
  }

Sie können mit dem Prefer: outlook.timezone-Header alle datumsbezogenen Eigenschaften in der Antwort in einer anderen Zeitzone als UTC darstellen.

Die datumsbezogenen Eigenschaften in der Aufgaben-Ressource beinhalten Folgendes:

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

Standardmäßig geben die Operationen POST, GET, PATCH und Complete datumsbezogene Eigenschaften in ihren REST-Antworten in UTC zurück. Sie können mit dem Prefer: outlook.timezone-Header alle datumsbezogenen Eigenschaften in der Antwort in einer anderen Zeitzone als UTC darstellen. Das folgende Beispiel gibt datumsbezogene Eigenschaften in EST in der entsprechenden Antwort zurück:

Prefer: outlook.timezone="Eastern Standard Time"

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

Aufgaben erstellen

Minimal benötigter Bereich

Erstellen einer Aufgabe an. Es gibt 2 Hauptszenarien.

Sie können eine Aufgabe in der Standardaufgabengruppe (My Tasks) und im Standardaufgabenordner (Tasks) im Postfach des Benutzers erstellen. In diesem Fall müssen Sie keine Aufgabengruppe und keinen Aufgabenordner angeben.

POST https://outlook.office.com/api/v2.0/me/tasks

Sie können eine Aufgabe auch in einem bestimmten Aufgabenordner erstellen:

POST https://outlook.office.com/api/v2.0/me/taskfolders('{folder_id}')/tasks

Geben Sie im Anforderungstext eine JSON-Darstellung der zu erstellenden Aufgabe an.

Weitere Informationen zur Einstellung von StartDateTime und DueDateTime.

Finden Sie heraus, wie Sie eine bestimmte Zeitzone für alle datumsbezogenen Eigenschaften in der Antwort angeben können.

Antwort

Erfolgsstatuscode: 201 Erstellt

Antworttext: Die erstellte Aufgabe.

Beispielanfrage

Das erste Beispiel erstellt eine Aufgabe im angegebenen Aufgabenordner und drückt StartDateTime und DueDateTime in Pacific Normalzeit (PST) im Anforderungstext aus.

POST https://outlook.office.com/api/v2.0/me/taskfolders('AAMkADIyAAAhrbPXAAA=')/tasks
Content-Type: application/json

{
  "Subject": "Shop for dinner",
  "StartDateTime": {
      "DateTime": "2016-04-23T18:00:00",
      "TimeZone": "Pacific Standard Time"
  },
  "DueDateTime":  {
      "DateTime": "2016-04-25T13:00:00",
      "TimeZone": "Pacific Standard Time"
  }
}

Beispielantwort

Die POST-Methode ignoriert den Zeitanteil im Anforderungstext und geht davon aus, dass die Zeit immer Mitternacht in der angegebenen Zeitzone (PST) ist. Die POST-Methode konvertiert dann standardmäßig alle datumsbezogenen Eigenschaften in der Antwort in UTC.

Status code: 201 Created

{
  "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/TaskFolders('AAMkADIyAAAhrbPXAAA%3D')/Tasks/$entity",
  "@odata.id": "https://outlook.office.com/api/v2.0/Users('dc2d952a-78ff-4609-b3ae-eb66271747bf@8638a6dc-2d66-40dc-aecb-b2436ec47fc0')/Tasks('AAMkADIyAAAhrb_PAAA=')",
  "@odata.etag": "W/\"hmM7Eb/jgEec8l3+gkJEawAAIbAOlw==\"",
  "Id": "AAMkADIyAAAhrb_PAAA=",
  "CreatedDateTime": "2016-04-22T05:44:01.2012012Z",
  "LastModifiedDateTime": "2016-04-22T05:44:02.9980882Z",
  "ChangeKey": "1/KC9Vmu40G3DwB6Lgs7MAAAIOJMxw==",
  "Categories": [ ],
  "AssignedTo": null,
  "Body": {
    "ContentType": "Text",
    "Content": ""
  },
  "CompletedDateTime": null,
  "DueDateTime": {
    "DateTime": "2016-04-25T07:00:00.0000000",
    "TimeZone": "UTC"
  },
  "HasAttachments":false,
  "Importance": "Normal",
  "IsReminderOn": false,
  "Owner": "Administrator",
  "ParentFolderId": "AQMkADA1MTkAAAAIBEgAAAA==",
  "Recurrence": null,
  "ReminderDateTime": null,
  "Sensitivity": "Normal",
  "StartDateTime": {
    "DateTime": "2016-04-23T07:00:00.0000000",
    "TimeZone": "UTC"
  },
  "Status": "NotStarted",
  "Subject": "Shop for dinner"
}

Beispielanfrage

Als Darstellung wie der Prefer: outlook.timezone-Header funktioniert, erstellt das nächste Beispiel eine Aufgabe, die StartDateTime und DueDateTime in Eastern Normalzeit (EST) ausdrückt und einen Prefer-Header in Pacific Normalzeit (PST) enthält.

POST https://outlook.office.com/api/v2.0/me/tasks HTTP/1.1

Content-Type: application/json
Prefer: outlook.timezone="Pacific Standard Time"

{
  "Subject": "Shop for children's weekend",
  "StartDateTime": {
      "DateTime": "2016-05-03T09:00:00",
      "TimeZone": "Eastern Standard Time"
  },
  "DueDateTime":  {
      "DateTime": "2016-05-05T16:00:00",
      "TimeZone": "Eastern Standard Time"
  }
}

Beispielantwort

Genau wie im letzten Beispiel ignoriert die POST-Methode ignoriert den Zeitanteil von StartDateTime und DueDateTime im Anforderungstext und geht davon aus, dass die Zeit immer Mitternacht in der angegebenen Zeitzone (EST) ist.

Da der Prefer-Header PST angibt, drückt die POST-Methode alle datumsbezogenen Eigenschaften in der Antwort in PST aus. Insbesondere für die Eigenschaften StartDateTime und DueDateTime konvertiert die POST-Methode Mitternacht in EST in PST und gibt sie in der Antwort in PST zurück.

Status code: 201 Created

{
    "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Tasks/$entity",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/Tasks('AAMkADA1MHgwAAA=')",
    "@odata.etag": "W/\"1/KC9Vmu40G3DwB6Lgs7MAAAIW9XXA==\"",
    "Id": "AAMkADA1MHgwAAA=",
    "CreatedDateTime": "2016-04-22T15:19:18.9526004-07:00",
    "LastModifiedDateTime": "2016-04-22T15:19:19.015101-07:00",
    "ChangeKey": "1/KC9Vmu40G3DwB6Lgs7MAAAIW9XXA==",
    "Categories": [
    ],
    "AssignedTo": null,
    "Body": {
        "ContentType": "Text",
        "Content": ""
    },
    "CompletedDateTime": null,
    "DueDateTime": {
        "DateTime": "2016-05-04T21:00:00.0000000",
        "TimeZone": "Pacific Standard Time"
    },
    "HasAttachments":false,
    "Importance": "Normal",
    "IsReminderOn": false,
    "Owner": "Administrator",
    "ParentFolderId": "AQMkADA1MTEgAAAA==",
    "Recurrence": null,
    "ReminderDateTime": null,
    "Sensitivity": "Normal",
    "StartDateTime": {
        "DateTime": "2016-05-02T21:00:00.0000000",
        "TimeZone": "Pacific Standard Time"
    },
    "Status": "NotStarted",
    "Subject": "Shop for children's weekend"
}

Aufgaben abrufen

Alle Aufgaben abrufen

Minimal benötigter Bereich

Ruft mehrere Aufgaben ab.

Sie können alle Aufgaben im Postfach des angemeldeten Benutzers abrufen.

GET https://outlook.office.com/api/v2.0/me/tasks

Oder Sie können alle Aufgaben in einem bestimmten Ordner abrufen:

GET https://outlook.office.com/api/v2.0/me/taskfolders('{folder_id}')/tasks

Wenn es mehr als eine Aufgabengruppe gibt und Sie alle Aufgaben in einer bestimmten Aufgabengruppe abrufen möchten, rufen Sie zunächst alle Aufgabenordner in dieser Aufgabengruppe ab und danach die Aufgaben in jedem dieser Aufgabenordner.

Antwort

Erfolgsstatuscode: 200 OK

Antworttext: Eine Aufgabensammlung

Standardmäßig sind die datumsbezogene Eigenschaften in der Antwort in UTC ausgedrückt. Finden Sie heraus, wie Sie eine bestimmte Zeitzone für alle datumsbezogenen Eigenschaften in der Antwort angeben können.

Beispielanfrage

Das folgende Beispiel ruft alle Aufgaben im Postfach des Benutzers ab.

GET https://outlook.office.com/api/v2.0/me/tasks

Beispielantwort

Status code: 200 OK

{
  "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Tasks",
  "value": [
    {
      "@odata.id": "https://outlook.office.com/api/v2.0/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/Tasks('AAMkADA1MTrfAAA=')",
      "@odata.etag": "W/\"1/KC9Vmu40G3DwB6Lgs7MAAAIOJMxw==\"",
      "Id": "AAMkADA1MTrfAAA=",
      "CreatedDateTime": "2016-04-22T05:44:01.2012012Z",
      "LastModifiedDateTime": "2016-04-22T05:44:02.9980882Z",
      "ChangeKey": "1/KC9Vmu40G3DwB6Lgs7MAAAIOJMxw==",
      "Categories": [ ],
      "AssignedTo": null,
      "Body": {
        "ContentType": "Text",
        "Content": ""
      },
      "CompletedDateTime": null,
      "DueDateTime": {
        "DateTime": "2016-04-25T07:00:00.0000000",
        "TimeZone": "UTC"
      },
      "HasAttachments":false,
      "Importance": "Normal",
      "IsReminderOn": false,
      "Owner": "Administrator",
      "ParentFolderId": "AQMkADA1MTBEgAAAA==",
      "Recurrence": null,
      "ReminderDateTime": null,
      "Sensitivity": "Normal",
      "StartDateTime": {
        "DateTime": "2016-04-23T07:00:00.0000000",
        "TimeZone": "UTC"
      },
      "Status": "NotStarted",
      "Subject": "Shop for dinner"
    },
    {
      "@odata.id": "https://outlook.office.com/api/v2.0/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/Tasks('AAMkADA1MTrgAAA=')",
      "@odata.etag": "W/\"1/KC9Vmu40G3DwB6Lgs7MAAAIOJMyQ==\"",
      "Id": "AAMkADA1MTrgAAA=",
      "CreatedDateTime": "2016-04-22T06:03:35.9279794Z",
      "LastModifiedDateTime": "2016-04-22T06:03:35.9436052Z",
      "ChangeKey": "1/KC9Vmu40G3DwB6Lgs7MAAAIOJMyQ==",
      "Categories": [ ],
      "AssignedTo": null,
      "Body": {
        "ContentType": "Text",
        "Content": ""
      },
      "CompletedDateTime": null,
      "DueDateTime": {
        "DateTime": "2016-04-27T04:00:00.0000000",
        "TimeZone": "UTC"
      },
      "HasAttachments":false,
      "Importance": "Normal",
      "IsReminderOn": false,
      "Owner": "Administrator",
      "ParentFolderId": "AQMkADA1MTBEgAAAA==",
      "Recurrence": null,
      "ReminderDateTime": null,
      "Sensitivity": "Normal",
      "StartDateTime": {
        "DateTime": "2016-04-26T04:00:00.0000000",
        "TimeZone": "UTC"
      },
      "Status": "NotStarted",
      "Subject": "Shop for dinner"
    }
  ]
}

Eine Aufgabe abrufen

Minimal benötigter Bereich

Rufen Sie eine bestimmte Aufgabe ab.

GET https://outlook.office.com/api/v2.0/me/tasks('{task_id}')

Antwort

Erfolgsstatuscode: 200 OK

Antworttext: Die angeforderte Aufgabe.

Standardmäßig sind die datumsbezogene Eigenschaften in der Antwort in UTC ausgedrückt. Finden Sie heraus, wie Sie eine bestimmte Zeitzone für alle datumsbezogenen Eigenschaften in der Antwort angeben können.

Beispielanfrage

GET https://outlook.office.com/api/v2.0/me/tasks('AAMkADA1MTrgAAA=') 

Beispielantwort

Status code: 200 OK

{
  "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Tasks/$entity",
  "@odata.id": "https://outlook.office.com/api/v2.0/Users('dc2d952a-78ff-4609-b3ae-eb66271747bf@8638a6dc-2d66-40dc-aecb-b2436ec47fc0')/Tasks('AAMkADA1MTrgAAA=')",
  "@odata.etag": "W/\"hmM7Eb/jgEec8l3+gkJEawAAIa/+kw==\"",
  "Id": "AAMkADA1MTrgAAA=",
  "CreatedDateTime": "2016-04-22T06:03:35.9279794Z",
  "LastModifiedDateTime": "2016-04-22T06:03:35.9436052Z",
  "ChangeKey": "1/KC9Vmu40G3DwB6Lgs7MAAAIOJMyQ==",
  "Categories": [ ],
  "AssignedTo": null,
  "Body": {
    "ContentType": "Text",
    "Content": ""
  },
  "CompletedDateTime": null,
  "DueDateTime": {
    "DateTime": "2016-04-27T04:00:00.0000000",
    "TimeZone": "UTC"
  },
  "HasAttachments":false,
  "Importance": "Normal",
  "IsReminderOn": false,
  "Owner": "Administrator",
  "ParentFolderId": "AQMkADA1MTBEgAAAA==",
  "Recurrence": null,
  "ReminderDateTime": null,
  "Sensitivity": "Normal",
  "StartDateTime": {
    "DateTime": "2016-04-26T04:00:00.0000000",
    "TimeZone": "UTC"
  },
  "Status": "NotStarted",
  "Subject": "Shop for dinner"
}

Aktualisieren von Vorgängen

Minimal benötigter Bereich

Ändert die beschreibbaren Eigenschaften einer Aufgabe.

PATCH https://outlook.office.com/api/v2.0/me/tasks/{task_id}

Geben Sie im Anforderungstext eine JSON-Darstellung der beschreibbaren Eigenschaften der zu aktualisierenden Aufgabe an.

Weitere Informationen zur Einstellung von StartDateTime und DueDateTime.

Die Eigenschaft CompletedDateTime kann mit der Aktion Complete oder explizit mit einer PATCH-Operation gesetzt werden. Wenn Sie PATCH für die Einstellung von CompletedDateTime verwenden, stellen Sie sicher, dass Sie Status ebenfalls auf Completed einstellen.

Standardmäßig sind die datumsbezogenen Eigenschaften in der Antwort in UTC ausgedrückt. Finden Sie heraus, wie Sie eine bestimmte Zeitzone für alle datumsbezogenen Eigenschaften in der Antwort angeben können.

Antwort

Erfolgsstatuscode: 200 OK

Antworttext: Die aktualisierte Aufgabe.

Beispielanfrage

Das folgende Beispiel ändert DueDateTime und verwendet den Prefer: outlook.timezone-Header, um die datumsbezogenen Eigenschaften festzulegen, die in der Antwort in Eastern Normalzeit (EST) ausgedrückt werden sollen.

PATCH https://outlook.office.com/api/v2.0/me/tasks('AAMkADA1MTHgwAAA=')

Prefer: outlook.timezone="Eastern Standard Time"
Content-Type: application/json

{
  "DueDateTime":  {
      "DateTime": "2016-05-06T16:00:00",
      "TimeZone": "Eastern Standard Time"
  }
}

Beispielantwort

Status code: 200 OK

{
  "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Tasks/$entity",
  "@odata.id": "https://outlook.office.com/api/v2.0/Users('dc2d952a-78ff-4609-b3ae-eb66271747bf@8638a6dc-2d66-40dc-aecb-b2436ec47fc0')/Tasks('AAMkADA1MTHgwAAA=')",
  "@odata.etag": "W/\"hmM7Eb/jgEec8l3+gkJEawAAIa/+lg==\"",
  "Id": "AAMkADA1MTHgwAAA=",
    "CreatedDateTime": "2016-04-22T18:19:18.9526004-04:00",
    "LastModifiedDateTime": "2016-04-22T18:38:20.5541528-04:00",
    "ChangeKey": "1/KC9Vmu40G3DwB6Lgs7MAAAIW9XXg==",
    "Categories": [
    ],
    "AssignedTo": null,
    "Body": {
        "ContentType": "Text",
        "Content": ""
    },
    "CompletedDateTime": null,
    "DueDateTime": {
        "DateTime": "2016-05-06T00:00:00.0000000",
        "TimeZone": "Eastern Standard Time"
    },
    "HasAttachments":false,
    "Importance": "Normal",
    "IsReminderOn": false,
    "Owner": "Administrator",
    "ParentFolderId": "AQMkADA1MTIBEgAAAA==",
    "Recurrence": null,
    "ReminderDateTime": null,
    "Sensitivity": "Normal",
    "StartDateTime": {
        "DateTime": "2016-05-03T00:00:00.0000000",
        "TimeZone": "Eastern Standard Time"
    },
    "Status": "NotStarted",
    "Subject": "Shop for children's weekend"
}

Aufgaben löschen

Minimal benötigter Bereich

Löscht die angegebene Aufgabe im Postfach des Benutzers.

DELETE https://outlook.office.com/api/v2.0/me/tasks('{task_id}')

Antwort

Erfolgsstatuscode: 204 Kein Inhalt

Antworttext: Keine

Beispielanfrage

DELETE https://outlook.office365.com/api/v2.0/me/tasks('AAMkADIyAAAhrb_QAAA=')

Beispielantwort

Status code: 204 No Content

Aufgaben erledigen

Minimal benötigter Bereich

Erledigt eine Aufgabe und stellt die Eigenschaft CompletedDateTime auf das aktuelle Datum und die EigenschaftStatus auf Completed ein.

POST https://outlook.office.com/api/v2.0/me/tasks('{task_id}')/complete

Hinweis

CompletedDateTime stellt das Datum dar, an dem die Aufgabe beendet ist. Der Zeitanteil von CompletedDateTime ist standardmäßig auf Mitternacht UTC eingestellt.

Eine App kann eine eigene Zeitzone in einem Prefer-Anforderungs-Header angeben. Das folgende ist ein Beispiel für die Einstellung von CompletedDateTime auf die Zeitzone Pacific Normalzeit (PST):

Prefer: outlook.timezone="Pacific Standard Time"

Dieser Anforderungs-Header stellt alle datumsbezogenen Eigenschaften in der Antwort auf die angegebene Zeitzone ein.

Antwort

Erfolgsstatuscode: 200 OK

Antworttext: Die abgeschlossene Aufgabe in einer Aufgabensammlung. Wenn Sie eine Aufgabe in einer Terminserie erledigen, enthält die Aufgabensammlung die erledigte Aufgabe der Serie und die nächste Aufgabe der Serie.

Beispielanfrage

Das folgende Beispiel kennzeichnet die angegebene Aufgabe als erledigt. Da Pacific Normalzeit (PST) im Prefer: outlook.timezone-Header angegeben wird, werden CompletedDateTime und andere datumsbezogene Eigenschaften in der Antwort in PST ausgedrückt.

POST https://outlook.office.com/api/v2.0/me/tasks('AAMkADA1MT15rfAAA=')/complete

Prefer: outlook.timezone="Pacific Standard Time"

Beispielantwort

Status code: 200 OK

{
  "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Tasks",
  "value": [
    {
      "@odata.id": "https://outlook.office365.com/api/v2.0/Users('dc2d952a-78ff-4609-b3ae-eb66271747bf@8638a6dc-2d66-40dc-aecb-b2436ec47fc0')/Tasks('AAMkADA1MT15rfAAA=')",
      "@odata.etag": "W/\"hmM7Eb/jgEec8l3+gkJEawAAIa/+lw==\"",
      "Id": "AAMkADA1MT15rfAAA=",
      "CreatedDateTime": "2016-04-21T22:44:01.2012012-07:00",
      "LastModifiedDateTime": "2016-04-22T19:28:38.5300447-07:00",
      "ChangeKey": "1/KC9Vmu40G3DwB6Lgs7MAAAIW9XYQ==",
      "Categories": [
      ],
      "AssignedTo": null,
      "Body": {
          "ContentType": "Text",
          "Content": ""
      },
      "CompletedDateTime": {
          "DateTime": "2016-04-22T00:00:00.0000000",
          "TimeZone": "Pacific Standard Time"
      },
      "DueDateTime": {
          "DateTime": "2016-04-25T00:00:00.0000000",
          "TimeZone": "Pacific Standard Time"
      },
      "HasAttachments":false,
      "Importance": "Normal",
      "IsReminderOn": false,
      "Owner": "Administrator",
      "ParentFolderId": "AQMkADA1MTIBEgAAAA==",
      "Recurrence": null,
      "ReminderDateTime": null,
      "Sensitivity": "Normal",
      "StartDateTime": {
          "DateTime": "2016-04-21T00:00:00.0000000",
          "TimeZone": "Pacific Standard Time"
      },
      "Status": "Completed",
      "Subject": "Shop for dinner"
    }
  ]
}

Aufgaben oder Aufgabenordner synchronisieren

Minimal benötigter Bereich

Sie können Aufgaben in einem Aufgabenordner oder Aufgabenordner im Postfach eines Benutzers synchronisieren. Das Synchronisieren von Aufgaben wird pro Ordner durchgeführt, z. B. können Sie alle Aufgaben in Ihrem Tasks-Standardaufgabenordner synchronisieren. Sie müssen zum Synchronisieren der Aufgaben in einer Ordnerhierarchie jeden Aufgabenordner einzeln synchronisieren. Die Prozesse zum Synchronisieren von Aufgaben oder Aufgabenordnern sind ähnlich und erfordern gewöhnlich eine Runde von zwei oder mehr Synchronisierungsanforderungen, jeweils ein GET-Aufruf.

Verwenden Sie die GET-Methode ähnlich wie Sie Aufgaben in einem Ordner aufrufen, oder Aufgaben in einem Postfach abrufen, außer dass Sie bestimmte Anforderungs-Header sowie ein deltaToken oder ein skipToken einfügen, soweit angemessen.

Anforderungsheader

  • Sie müssen den Prefer: odata.track-changes-Header in allen Synchronisierungsanforderungen angeben, mit Ausnahme derer, die eine skipToken enthalten, die von einer vorherigen Synchronisierungsanforderung zurückgegeben wird. Suchen Sie in der ersten Antwort nach dem Preference-Applied: odata.track-changes-Header, um vor dem Fortfahren zu bestätigen, dass die Ressource die Synchronisierung unterstützt. (Weitere Informationen über eine skipToken in -Daten der zweiten Stichprobenantwort für Aufgaben, wenn Sie Aufgaben synchronisieren, oder -Daten der zweiten Stichprobenantwort für Aufgabenordner, wenn Sie Aufgaben synchronisieren.)
  • Sie können den Prefer: odata.maxpagesize={x} -Header angeben, um die maximale Anzahl von Aufgaben (oder Aufgabenordnern, je nachdem, welche Sie synchronisieren) anzugeben, die jede Synchronisierungsanforderung zurückgibt.

Hier ist eine typische Synchronisierungsrunde:

  1. Stellen Sie die erste GET-Anforderung mit dem erforderlichen Prefer: odata.track-changes-Header. Die erste Antwort auf eine Synchronisierungsanforderung liefert immer ein deltaToken. (Die zweite und nachfolgende GET-Anforderungen unterscheiden sich von der ersten GET-Anforderung, indem sie entweder ein deltaToken oder ein skipToken enthalten, das in einer früheren Antwort empfangen wurde.)

  2. Wenn die erste Antwort den Preference-Applied: odata.track-changes-Header zurückgibt, können Sie mit der Synchronisierung der Ressource fortfahren.

    • Stellen Sie eine zweite GET-Anforderung. Geben Sie den Prefer: odata.track-changes-Header und das deltaToken aus dem ersten GET zurück, um festzustellen, ob es weitere Instanzen der zu synchronisierenden Ressource gibt. Die zweite Anfrage gibt zusätzliche Instanzen zurück und entweder ein skipToken, wenn mehr Instanzen verfügbar sind, oder ein deltaToken, wenn die letzte Instanz synchronisiert wurde, in diesem Fall können Sie aufhören.

    • Setzen Sie die Synchronisierung fort, indem Sie einen GET-Aufruf senden und ein skipToken einfügen, das vom vorherigen Aufruf zurückgegeben wird. Hören Sie auf, wenn Sie eine endgültige Antwort erhalten, die einen _@odata.deltaLink_-Header mit einem deltaToken enthält. Die zeigt an, dass die Synchronisierung abgeschlossen wurde.

Werfen Sie einen Blick auf die Syntax für die ersten und nachfolgenden Aufrufe in einer Synchronisierungsrunde.

Aufgaben in einem Aufgabenordner synchronisieren

Ursprüngliche Anforderung:

GET https://outlook.office.com/api/v2.0/me/TaskFolders('{folder_id}')/Tasks

Zweite Anforderung oder erste Anforderung einer nachfolgenden Runde:

GET https://outlook.office.com/api/v2.0/me/TaskFolders('{folder_id}')/Tasks/?$deltatoken={delta_token}

Die dritte oder nachfolgende Anforderung in derselben Runde; hören Sie auf, wenn Sie eine Anforderung erhalten, die einen @odata.deltaLink-Header mit deltaToken enthält:

GET https://outlook.office.com/api/v2.0/me/TaskFolders('{folder_id}')/Tasks/?$skiptoken={skip_token}

So synchronisieren Sie Aufgabenordner in einem Postfach

Ursprüngliche Anforderung:

GET https://outlook.office.com/api/v2.0/me/TaskFolders

Zweite Anforderung oder erste Anforderung einer nachfolgenden Runde:

GET https://outlook.office.com/api/v2.0/me/TaskFolders/?$deltatoken={delta_token}

Die dritte oder nachfolgende Anforderung in derselben Runde; hören Sie auf, wenn Sie eine Anforderung erhalten, die einen @odata.deltaLink-Header mit deltaToken enthält:

GET https://outlook.office.com/api/v2.0/me/TaskFolders/?$skiptoken={skip_token}

Parameter

Parameter Typ Beschreibung
Header-Parameter
Bevorzugt odata.track-Änderungen Zeigt an, dass es sich bei der Anforderung um eine Synchronisierungsanforderung handelt. Erforderlich für die ersten 2 GET-Anforderungen in einer Runde.
Bevorzugt odata.maxpagesize Legt die Anzahl der in jeder Antwort zurückgegebenen Nachrichten fest. Optional.
URL-Parameter
deltaToken Zeichenfolge Die Zeichenfolge deltaToken wird als Teil des Wertes für @odata.deltaLink in der vorherigen Synchronisierungsantwort zurückgegeben.
skipToken Zeichenfolge Die Zeichenfolge skipToken wird als Teil des Wertes für @odata.nextLink in der vorherigen Synchronisierungsantwort zurückgegeben.

Hinweis

  • Bei Angabe von Prefer: odata.track-changes in der ersten Anforderung, wenn die Antwort Synchronisierung unterstützt, würde die Antwort Preference-applied: odata.track-changes im Header enthalten.
  • Wenn Sie versuchen, eine Ressource zu synchronisieren, die nicht unterstützt wird, oder wenn dies nicht die anfängliche Synchronisierungsanforderung ist, sehen Sie den Preference-applied-Header nicht in der Antwort.
  • Verwenden Sie für eine bessere Antwortzeit den Abfrageparameter $select, um nur die für Ihr Szenario nützlichen Eigenschaften zu erhalten.
  • Sie können die Abfrageparameter $filter, $orderby, $search und $top nicht verwenden.

Antworttext

  • Wenn Sie Aufgaben synchronisieren: die angeforderten Aufgabenobjekte in einer Sammlung.

  • Wenn Sie Aufgabenordner synchronisieren: die angeforderten TaskFolder-Objekte in einer Sammlung.

Die Anzahl der Objekte richtet sich nach dem im Prefer: odata.maxpagesize-Anforderungsheader eingestellten Wert.

Beispiel

Im Folgenden werden zwei Beispiele gezeigt:

Jedes Beispiel zeigt die erste und zweite Synchronisierungsanforderung.

  • Jede Anforderung gibt Prefer: odata.maxpagesize=1 an, um jeweils nur ein Objekt (Aufgabe bzw. Aufgabenordner) zurückzugeben.
  • Die erste Antwort gibt ein synchronisiertes Objekt zurück, deltaLink und deltaToken.
  • Die zweite Anforderung verwendet deltatoken. Die zweite Antwort gibt ein synchronisiertes Objekt zurück, nextLink und skipToken.

Durchlaufen Sie den Synchronisierungsprozess und verwenden Sie beim nächsten GET-Aufruf skipToken, die von der vorherigen Synchronisierungsanfrage zurückgegeben wird, bis Sie eine Synchronisierungsantwort erhalten, die wie folgt deltaLink und deltaToken enthalten:

"@odata.deltaLink": “https://outlook.office.com/api/v2.0/me/TaskFolders('AQMkAGMw80AAAIBEgAAAA==')/Tasks/?%24deltaToken=294a8f04cc0345c5ae093d484629e186”

Wenn dies geschieht, ist diese Synchronisierungsrunde abgeschlossen. Speichern Sie deltaToken für die nächste Synchronisierungsrunde.

Erste Stichprobenanforderung (Aufgaben synchronisieren)

    GET https://outlook.office.com/api/v2.0/me/TaskFolders('AQMkAGMwAAAIBEgAAAA==')/Tasks HTTP/1.1
    Prefer: odata.maxpagesize=1
  Prefer: odata.track-changes

Daten der ersten Stichprobenantwort (Aufgaben synchronisieren)

HTTP/1.1 200 OK
Preference-Applied: odata.track-changes

{
  "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#me/TaskFolders('AQMkAGMwAAAIBEgAAAA%3D%3D')/Tasks",
  "value": [
    {
      "@odata.id": "https://outlook.office.com/api/v2.0/Users('47ec4680-f443-4f9c-a3e5-f7660f0aceae@b4ffe6c0-e717-4104-acd1-e9dfe38ff5f9')/Tasks('AAMkAGMwQsKVevNAAAG1VNmAAA=')",
      "@odata.etag": "W/\"3JfzyLwJe0mPNcULClXrzQAABtYBDw==\"",
      "Id": "AAMkAGMwQsKVevNAAAG1VNmAAA=",
      "CreatedDateTime": "2016-02-29T20:51:25.2226052Z",
      "LastModifiedDateTime": "2016-02-29T20:51:25.2538576Z",
      "ChangeKey": "3JfzyLwJe0mPNcULClXrzQAABtYBDw==",
      "Categories": [ ],
      "AssignedTo": null,
      "Body": {
        "ContentType": "Text",
        "Content": ""
      },
      "CompletedDateTime": null,
      "DueDateTime": null,
      "HasAttachments":false,
      "Importance": "Normal",
      "IsReminderOn": false,
      "Owner": "Administrator",
      "ParentFolderId": "AQMkAGMwAAAIBEgAAAA==",
      "Recurrence": null,
      "ReminderDateTime": null,
      "Sensitivity": "Normal",
      "StartDateTime": null,
      "Status": "NotStarted",
      "Subject": "another task"
    }
  ],
  "@odata.deltaLink": "https://outlook.office.com/api/v2.0/me/TaskFolders('AQMkAGMwAAAIBEgAAAA==')/Tasks/?%24deltatoken=175e2e04482e431ea96e89145c212f8c"
}

Zweite Stichprobenantwort (Aufgaben synchronisieren)

    GET https://outlook.office.com/api/v2.0/me/TaskFolders('AQMkAGMwAAAIBEgAAAA==')/Tasks/?%24deltatoken=175e2e04482e431ea96e89145c212f8c HTTP/1.1
    Prefer: odata.maxpagesize=1
  Prefer: odata.track-changes

Daten der zweiten Stichprobenantwort (Aufgaben synchronisieren)

HTTP/1.1 200 OK

{
  "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#me/TaskFolders('AQMkAGMwAAAIBEgAAAA%3D%3D')/Tasks/$delta",
  "value": [
    {
      "@odata.id": "https://outlook.office.com/api/v2.0/Users('47ec4680-f443-4f9c-a3e5-f7660f0aceae@b4ffe6c0-e717-4104-acd1-e9dfe38ff5f9')/Tasks('AAMkAGMwQsKVevNAAAG1VNlAAA=')",
      "@odata.etag": "W/\"3JfzyLwJe0mPNcULClXrzQAABtYBDQ==\"",
      "Id": "AAMkAGMwQsKVevNAAAG1VNlAAA=",
      "CreatedDateTime": "2016-02-29T20:51:02.5955351Z",
      "LastModifiedDateTime": "2016-02-29T20:51:03.9703679Z",
      "ChangeKey": "3JfzyLwJe0mPNcULClXrzQAABtYBDQ==",
      "Categories": [ ],
      "AssignedTo": null,
      "Body": {
        "ContentType": "Text",
        "Content": ""
      },
      "CompletedDateTime": null,
      "DueDateTimeTime": null,
      "HasAttachments":false,
      "Importance": "Normal",
      "IsReminderOn": false,
      "Owner": "Administrator",
      "ParentFolderId": "AQMkAGMwAAAIBEgAAAA==",
      "Recurrence": null,
      "ReminderDateTime": null,
      "Sensitivity": "Normal",
      "StartDateTime": null,
      "Status": "NotStarted",
      "Subject": "another task"
    }
  ],
  "@odata.nextLink": "https://outlook.office.com/api/v2.0/me/TaskFolders('AQMkAGMw80AAAIBEgAAAA==')/Tasks/?%24skipToken=0fbce2031e844a2f9d13d8bee5ebe2c6"
}

Setzen Sie die Synchronisierung der Aufgaben fort und verwenden Sie im nächsten GET-Aufruf skiptoken, der in @odata.nextLink der vorherigen Antwort zurückgegeben wird, bis die endgültige Antwort @odata.deltaLink und deltaTokenenthält. Speichern Sie deltaToken für die nächste Synchronisierungsrunde.

Erste Stichprobenanforderung (Aufgabenordner synchronisieren)

    GET https://outlook.office.com/api/v2.0/me/TaskFolders HTTP/1.1
    Prefer: odata.maxpagesize=1
    Prefer: odata.track-changes

Daten der ersten Stichprobenantwort (Aufgabenordner synchronisieren)

HTTP/1.1 200 OK
Preference-Applied: odata.track-changes

{
    "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#me/TaskFolders",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v2.0/Users('5bcd7334-a6c5-4f95-a370-319e077dfe10@e288a0d0-ab74-431b-9699-a3721aabb08f')/TaskFolders('AAMkAGJiAAAAAAESAAA=')",
            "Id": "AAMkAGJiAAAAAAESAAA=",
            "ChangeKey": "PG2a661l00Cy9qH3YxmDfwAAAAAAPA==",
            "Name": "Tasks",
            "IsDefaultFolder":true,
            "ParentGroupKey": "0006f0b7-0000-0000-c000-000000000046"
        }
    ],
    "@odata.deltaLink": "https://outlook.office.com/api/v2.0/me/TaskFolders/?%24deltatoken=OyZKBDxtmuutZdNAsvah92MZg38AAAAAZwkBAAAA"
}

Zweite Stichprobenanforderung (Aufgabenordner synchronisieren)

    GET https://outlook.office.com/api/v2.0/me/TaskFolders/?%24deltatoken=OyZKBDxtmuutZdNAsvah92MZg38AAAAAZwkBAAAA HTTP/1.1
    Prefer: odata.maxpagesize=1
    Prefer: odata.track-changes

Daten der zweiten Stichprobenantwort (Aufgabenordner synchronisieren)

HTTP/1.1 200 OK

{
    "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#me/TaskFolders/$delta",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v2.0/Users('5bcd7334-a6c5-4f95-a370-319e077dfe10@e288a0d0-ab74-431b-9699-a3721aabb08f')/TaskFolders('AAMkAGI5AAAunDbWAAA=')",
            "Id": "AAMkAGI5AAAunDbWAAA=",
            "ChangeKey": "PmebZ1wYAUaTmrKkvU9LIQAALqEkaw==",
            "Name": "Bingo",
            "IsDefaultFolder":false,
            "ParentGroupKey": "db0823f2-93bd-4db6-8038-98bbc5f39a45"
        }
    ],
    "@odata.nextLink": "https://outlook.office.com/api/v2.0/me/TaskFolders/?%24skipToken=x_zCAz5nm2dcGAFGk5qypL1PSyEAAC6cRncCAAAA"
}

Setzen Sie die Synchronisierung der Aufgaben fort und verwenden Sie im nächsten GET-Aufruf skiptoken, der in @odata.nextLink der vorherigen Antwort zurückgegeben wird, bis die endgültige Antwort @odata.deltaLink und deltaTokenenthält. In diesem Beispiel gibt die dritte Anforderung deltaToken zurück und die Synchronisierung ist für diese Runde abgeschlossen.

Dritte Stichprobenanforderung (Aufgabenordner synchronisieren)

    GET https://outlook.office.com/api/v2.0/me/TaskFolders/?%24skipToken=x_zCAz5nm2dcGAFGk5qypL1PSyEAAC6cRncCAAAA HTTP/1.1
    Prefer: odata.maxpagesize=1

Daten der dritten Stichprobenantwort (Aufgabenordner synchronisieren)

HTTP/1.1 200 OK

{
    "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#me/TaskFolders/$delta",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v2.0/Users('5bcd7334-a6c5-4f95-a370-319e077dfe10@e288a0d0-ab74-431b-9699-a3721aabb08f')/TaskFolders('AAMkAGI5AAAunDbVAAA=')",
            "Id": "AAMkAGI5AAAunDbVAAA=",
            "ChangeKey": "PmebZ1wYAUaTmrKkvU9LIQAALqEkZA==",
            "Name":"Volunteer",
            "IsDefaultFolder":false,
            "ParentGroupKey": "db0823f2-93bd-4db6-8038-98bbc5f39a45"
        }
    ],
    "@odata.deltaLink":"https://outlook.office.com/api/v2.0/me/taskfolders/?%24deltaToken=x_zCBD5nm2dcGAFGk5qypL1PSyEAAC6cRncEAAAA"
}

Anlagen abrufen

Eine Anlagensammlung abrufen

Minimal benötigter Bereich

Ruft die Anlagen einer bestimmten Aufgabe ab.

GET https://outlook.office.com/api/v2.0/me/tasks('{task_id}')/attachments

Antworttyp

Eine Anlagensammlung, die vom Typ FileAttachment oder ItemAttachment sein kann.

Beispielanfrage

Das folgende Beispiel gibt alle Anlagen der angegebenen Aufgabe zurück, die eine Datei und ein Ereigniselement enthalten.

GET https://outlook.office.com/api/v2.0/me/tasks('AAMkADNkN3qGAAA=')/attachments

Beispielantwort

Statuscode: 200

{
    "@odata.context":"https://outlook.office.com/api/v2.0/$metadata#Me/Tasks('AAMkADNkN3qGAAA%3D')/Attachments",
    "value":[
        {
            "@odata.type":"#Microsoft.OutlookServices.FileAttachment",
            "@odata.id":"https://outlook.office.com/api/v2.0/Users('fdcbcf34-2505-4d07-be5b-0a55b699d157@41a5b830-45ac-4f1b-9bfc-baafa3b7db2e')/Tasks('AAMkADNkN3qGAAA=')/Attachments('AAMkADNkNRT6JOBs=')",
            "Id":"AAMkADNkNRT6JOBs=",
            "LastModifiedDateTime":"2016-11-22T02:24:21Z",
            "Name":"Holiday notice",
            "ContentType":"application/octet-stream",
            "Size":244,
            "IsInline":false,
            "ContentId":null,
            "ContentLocation":null,
            "ContentBytes":"bWFjIGFuZCBjaGVlc2U="
        },
        {
            "@odata.type":"#Microsoft.OutlookServices.ItemAttachment",
            "@odata.id":"https://outlook.office.com/api/v2.0/Users('fdcbcf34-2505-4d07-be5b-0a55b699d157@41a5b830-45ac-4f1b-9bfc-baafa3b7db2e')/Tasks('AAMkADNkNS3qGAAA=')/Attachments('AAMkADNkNJVnQIe9r0=')",
            "Id":"AAMkADNkNJVnQIe9r0=",
            "LastModifiedDateTime":"2016-12-01T22:27:13Z",
            "Name":"Holiday event",
            "ContentType":null,
            "Size":2473,
            "IsInline":false
        }    
    ]
}

Eine Anlage abrufen

Minimal benötigter Bereich

Ruft eine Anlage zu einer bestimmten Aufgabe ab.

GET https://outlook.office.com/api/v2.0/me/tasks('{task_id}')/attachments('{attachment_id}')

Antworttyp

Die angeforderte Dateianlage oder Elementanlage.

Beispielanforderung (Dateianlage)

Das folgende Beispiel ruft eine bestimmten Anlage zu einer Aufgabe ab, die eine Dateianlage ist.

GET https://outlook.office.com/api/v2.0/me/tasks('AAMkADNkN3qGAAA=')/attachments('AAMkADNkNRT6JOBs=')

Beispielantwort

Statuscode: 200

{
    "@odata.context":"https://outlook.office.com/api/v2.0/$metadata#Me/Tasks('AAMkADNkN3qGAAA%3D')/Attachments/$entity",
    "@odata.type":"#Microsoft.OutlookServices.FileAttachment",
    "@odata.id":"https://outlook.office.com/api/v2.0/Users('fdcbcf34-2505-4d07-be5b-0a55b699d157@41a5b830-45ac-4f1b-9bfc-baafa3b7db2e')/Tasks('AAMkADNkN3qGAAA=')/Attachments('AAMkADNkNRT6JOBs=')",
    "Id":"AAMkADNkNRT6JOBs=",
    "LastModifiedDateTime":"2016-11-22T02:24:21Z",
    "Name":"Holiday notice",
    "ContentType":"application/octet-stream",
    "Size":244,
    "IsInline":false,
    "ContentId":null,
    "ContentLocation":null,
    "ContentBytes":"bWFjIGFuZCBjaGVlc2U="
}

Stichprobenanforderung (Elementanlage)

Das folgende Beispiel ruft eine bestimmten Anlage zu einer Aufgabe ab, die eine Elementanlage ist.

GET https://outlook.office.com/api/v2.0/me/tasks('AAMkADNkNS3qGAAA=')/attachments('AAMkADNkNJVnQIe9r0=')

Beispielantwort

Statuscode: 200

{
    "@odata.context":"https://outlook.office.com/api/v2.0/$metadata#Me/Tasks('AAMkADNkNS3qGAAA%3D')/Attachments/$entity",
    "@odata.type":"#Microsoft.OutlookServices.ItemAttachment",
    "@odata.id":"https://outlook.office.com/api/v2.0/Users('fdcbcf34-2505-4d07-be5b-0a55b699d157@41a5b830-45ac-4f1b-9bfc-baafa3b7db2e')/Tasks('AAMkADNkNS3qGAAA=')/Attachments('AAMkADNkNJVnQIe9r0=')",
    "Id":"AAMkADNkNJVnQIe9r0=",
    "LastModifiedDateTime":"2016-12-01T22:27:13Z",
    "Name":"Holiday event",
    "ContentType":null,
    "Size":2473,
    "IsInline":false
}

Hinzufügen von Anlagen

Sie können eine Datei, ein Element (Nachricht, Ereignis oder Kontakt) oder einen Link einer Datei als Anlage einer Aufgabe hinzufügen.

Hinzufügen von Dateianlagen

Minimal benötigter Bereich

Fügt eine Datei als Anlage einer Aufgabe hinzu.

POST https://outlook.office.com/api/v2.0/me/tasks('{task_id}')/attachments
Benötigte Textparameter Typ Beschreibung
@odata.type Zeichenfolge #Microsoft.OutlookServices.FileAttachment
Name Zeichenfolge Der Name der Anlage.
ContentBytes Binär Der Inhalt der Datei, die angefügt werden soll, in base64-Codierung.

Antworttyp

Die neue Dateianlage.

Beispielanfrage

POST https://outlook.office.com/api/v2.0/me/tasks('AAMkADNkN3qGAAA=')/attachments
Content-Type: application/json

{
    "@odata.type": "#Microsoft.OutlookServices.FileAttachment"", 
    "Name": "Holiday notice", 
    "ContentBytes": "bWFjIGFuZCBjaGVlc2U="
}

Beispielantwort

Statuscode: 201 Erstellt

{
    "@odata.context":"https://outlook.office.com/api/v2.0/$metadata#Me/Tasks('AAMkADNkN3qGAAA%3D')/Attachments/$entity",
    "@odata.type":"#Microsoft.OutlookServices.FileAttachment",
    "@odata.id":"https://outlook.office.com/api/v2.0/Users('fdcbcf34-2505-4d07-be5b-0a55b699d157@41a5b830-45ac-4f1b-9bfc-baafa3b7db2e')/Tasks('AAMkADNkN3qGAAA=')/Attachments('AAMkADNkNRT6JOBs=')",
    "Id":"AAMkADNkNRT6JOBs=",
    "LastModifiedDateTime":"2016-11-22T02:24:21Z",
    "Name":"Holiday notice",
    "ContentType":"application/octet-stream",
    "Size":244,
    "IsInline":false,
    "ContentId":null,
    "ContentLocation":null,
    "ContentBytes":"bWFjIGFuZCBjaGVlc2U="
}

Eine Elementanlage hinzufügen

Minimal benötigter Bereich

Fügt ein Element (Nachricht, Ereignis oder Kontakt) als Anlage einer Aufgabe hinzu.

POST https://outlook.office.com/api/v2.0/me/tasks('{task_id}')/attachments
Benötigte Textparameter Typ Beschreibung
@odata.type Zeichenfolge #Microsoft.OutlookServices.ItemAttachment
Name Zeichenfolge Der Name der Anlage.
Element Eine Nachricht-, Ereignis- oder Kontakt-Entität. Das anzufügende Element.

Antworttyp

Die neue Elementanlage.

Beispielanfrage

POST https://outlook.office.com/api/v2.0/me/tasks('AAMkADNkN3qGAAA=')/attachments
Content-Type: application/json

{
    "@odata.type": "#Microsoft.OutlookServices.ItemAttachment", 
    "Name": "Holiday event", 
    "Item": {
        "@odata.type": "Microsoft.OutlookServices.Event",
        "Subject": "Discuss gifts for children",
        "Body": {
            "ContentType": "HTML",
            "Content": "Let's look for funding!"
         },
         "Start": {
             "DateTime": "2016-12-02T18:00:00",
             "TimeZone": "Pacific Standard Time"
          },
          "End": {
             "DateTime": "2016-12-02T19:00:00",
             "TimeZone": "Pacific Standard Time"
           }
    }
}

Beispielantwort

Statuscode: 201 Erstellt

{
    "@odata.context":"https://outlook.office.com/api/v2.0/$metadata#Me/Tasks('AAMkADNkN3qGAAA%3D')/Attachments/$entity",
    "@odata.type":"#Microsoft.OutlookServices.ItemAttachment",
    "@odata.id":"https://outlook.office.com/api/v2.0/Users('fdcbcf34-2505-4d07-be5b-0a55b699d157@41a5b830-45ac-4f1b-9bfc-baafa3b7db2e')/Tasks('AAMkADNkN23qGAAA=')/Attachments('AAMkADNkN2Jp5JVnQIe9r0=')",
    "Id":"AAMkADNkNJp5JVnQIe9r0=",
    "LastModifiedDateTime":"2016-12-01T22:27:13Z",
    "Name":"Holiday event",
    "ContentType":null,
    "Size":2473,
    "IsInline":false
}

Eine Verweisanlage hinzufügen

Minimal benötigter Bereich

Fügt eine Verknüpfung einer Datei als Verweisanlage einer Aufgabe hinzu.

POST https://outlook.office.com/api/v2.0/me/tasks('{task_id}')/attachments
Benötigte Textparameter Typ Beschreibung
@odata.type Zeichenfolge #Microsoft.OutlookServices.ReferenceAttachment
Name Zeichenfolge Der Anzeigename der Anlage. Erforderlich.
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.

Geben Sie die Parameter Name und SourceUrl und alle beschreibbaren Verweisanlagen-Eigenschaften im Anforderungstext an.

Antworttyp

Die Verweisanlage.

Beispielanfrage

Das folgende Beispiel fügt eine Verweisanlage einer bestehenden Aufgabe hinzu. Die Anlage ist eine Verknüpfung mit einer Datei auf OneDrive for Business.

POST https://outlook.office.com/api/v2.0/me/tasks('AAMkADNkN3qGAAA=')/attachments
Content-Type: application/json

{
    "@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment", 
    "Name": "Hydrangea picture", 
    "SourceUrl": "https://contoso-my.sharepoint.com/personal/admin_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx?id=%2Fpersonal%2Fadmin%5Fcontoso%5Fonmicrosoft%5Fcom%2FDocuments%2FHydrangeas%2Ejpg&parent=%2Fpersonal%2Fadmin%5Fcontoso%5Fonmicrosoft%5Fcom%2FDocuments", 
    "ProviderType": "oneDriveBusiness", 
    "Permission": "Edit", 
    "IsFolder": "False" 
}

Beispielantwort

Statuscode: 201 Erstellt

{
    "@odata.context":"https://outlook.office.com/api/v2.0/$metadata#Me/Tasks('AAMkADNkN3qGAAA%3D')/Attachments/$entity",
    "@odata.type":"#Microsoft.OutlookServices.ReferenceAttachment",
    "@odata.id":"https://outlook.office.com/api/v2.0/Users('fdcbcf34-2505-4d07-be5b-0a55b699d157@41a5b830-45ac-4f1b-9bfc-baafa3b7db2e')/Tasks('AAMkADNkN3qGAAA=')/Attachments('AAMkADNkNQG1Lnn5-o=')",
    "Id":"AAMkADNkNQG1Lnn5-o=",
    "LastModifiedDateTime":"2016-11-22T02:32:44Z",
    "Name":"Hydrangea picture",
    "ContentType":null,
    "Size":850,
    "IsInline":true,
    "SourceUrl":"https://contoso-my.sharepoint.com/personal/admin_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx?id=%2Fpersonal%2Fadmin%5Fcontoso%5Fonmicrosoft%5Fcom%2FDocuments%2FHydrangeas%2Ejpg&parent=%2Fpersonal%2Fadmin%5Fcontoso%5Fonmicrosoft%5Fcom%2FDocuments",
    "ProviderType":"OneDriveBusiness",
    "ThumbnailUrl":null,
    "PreviewUrl":null,
    "Permission":"Edit",
    "IsFolder":false
}

Anlagen löschen

Eine Anlage einer Aufgabe löschen

Eine Anlage einer Aufgabe löschen

Minimal benötigter Bereich

Löscht die angegebene Anlage einer Aufgabe. Die Anlage kann eine Dateianlage oder Elementanlage sein.

DELETE https://outlook.office.com/api/v2.0/me/tasks('{task_id}')/attachments('{attachment_id}')

Beispielanfrage

DELETE https:/outlook.office.com/api/v2.0/me/tasks('AAMkADNkN3qGAAA=')/attachments('AAMkADNkNQG1Lnn5-o=')

Beispielantwort

Status code: 204

Aufgabenordner erstellen

Minimal benötigter Bereich

Erstellt einen Ordner.

Sie können einem Aufgabenorder in der Standardaufgabengruppe (My Tasks) im Postfach des Benutzers erstellen:

POST https://outlook.office.com/api/v2.0/me/taskfolders

Oder Sie können einen Aufgabenordner unter einer bestimmten Aufgabengruppe erstellen:

POST https://outlook.office.com/api/v2.0/me/taskgroups('{group_id}')/taskfolders

Geben Sie im Anforderungstext eine JSON-Darstellung der zu erstellenden TaskFolder an.

Antwort

Erfolgsstatuscode: 201 Erstellt

Antworttext: Die erstellte TaskFolder.

Beispielanfrage

Das folgende Beispiel erstellt einen Aufgabenordner namens Volunteer in der Standardaufgabengruppe (My Tasks) im Postfach des Benutzers.

POST https://outlook.office.com/api/v2.0/me/taskfolders 
Content-Type: application/json

{
  "Name": "Volunteer"
}

Beispielantwort

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/TaskFolders/$entity",
  "@odata.id": "https://outlook.office.com/api/v2.0/Users('dc2d952a-78ff-4609-b3ae-eb66271747bf@8638a6dc-2d66-40dc-aecb-b2436ec47fc0')/TaskFolders('AAMkADIyAAAhrbPWAAA=')",
  "Id": "AAMkADIyAAAhrbPWAAA=",
  "ChangeKey": "hmM7Eb/jgEec8l3+gkJEawAAIbAGig==",
  "IsDefaultFolder": false,
  "Name": "Volunteer",
  "ParentGroupKey": "0006f0b7-0000-0000-c000-000000000046"
}

Beispielanfrage

Das nächste Beispiel erstellt einen Aufgabenordner namens Cooking in der angegebenen Aufgabengruppe.

POST https://outlook.office.com/api/v2.0/me/taskgroups('AAMkADIyAAAhrbe-AAA')/taskfolders 
Content-Type: application/json

{
  "Name": "Cooking"
}

Beispielantwort

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/TaskGroups('AAMkADIyAAAhrbe-AAA%3D')/TaskFolders/$entity",
  "@odata.id": "https://outlook.office.com/api/v2.0/Users('dc2d952a-78ff-4609-b3ae-eb66271747bf@8638a6dc-2d66-40dc-aecb-b2436ec47fc0')/TaskFolders('AAMkADIyAAAhrbPXAAA=')",
  "Id": "AAMkADIyAAAhrbPXAAA=",
  "ChangeKey": "hmM7Eb/jgEec8l3+gkJEawAAIbAOlA==",
  "IsDefaultFolder": false,
  "Name": "Cooking",
  "ParentGroupKey": "63d640cf-946f-4734-9c29-60dda7b76acb"
}

Aufgabenordner abrufen

Minimal benötigter Bereich

Ruft mehrere Aufgabenordner ab.

Sie können alle Aufgabenordner im Postfach des Benutzers abrufen:

GET https://outlook.office.com/api/v2.0/me/taskfolders

Oder Sie können Aufgabenordner in einer bestimmten Aufgabengruppe abrufen:

GET https://outlook.office365.com/api/v2.0/me/taskgroups('{group_id}')/taskfolders 

Antwort

Erfolgsstatuscode: 200 OK

Antworttext: Eine taskfolder-Sammlung.

Beispielanfrage

Das folgende Beispiel ruft alle Aufgabenordner im Postfach des Benutzers ab.

GET https://outlook.office.com/api/v2.0/me/taskfolders

Beispielantwort

Status code: 200 OK

{
  "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/TaskFolders",
  "value": [
    {
      "@odata.id": "https://outlook.office.com/api/v2.0/Users('dc2d952a-78ff-4609-b3ae-eb66271747bf@8638a6dc-2d66-40dc-aecb-b2436ec47fc0')/TaskFolders('AAMkADIyAAAAABrJAAA=')",
      "Id": "AAMkADIyAAAAABrJAAA=",
      "ChangeKey": "hmM7Eb/jgEec8l3+gkJEawAAAAAeAA==",
      "IsDefaultFolder": false,
      "Name": "Monthly tasks",
      "ParentGroupKey": "0006f0b7-0000-0000-c000-000000000046"
    },
    {
      "@odata.id": "https://outlook.office.com/api/v2.0/Users('dc2d952a-78ff-4609-b3ae-eb66271747bf@8638a6dc-2d66-40dc-aecb-b2436ec47fc0')/TaskFolders('AAMkADIyAAAAAAESAAA=')",
      "Id": "AAMkADIyAAAAAAESAAA=",
      "ChangeKey": "hmM7Eb/jgEec8l3+gkJEawAAAAAAPA==",
      "IsDefaultFolder": true,
      "Name": "Tasks",
      "ParentGroupKey": "0006f0b7-0000-0000-c000-000000000046"
    }
  ]
}

Im nächsten Beispiel werden alle Aufgabenordner der angegebenen Aufgabengruppe abgerufen.

GET https://outlook.office365.com/api/v2.0/me/taskgroups('AAMkADIyAAAhrbe-AAA=')/taskfolders

Beispielantwort

Status code: 200 OK

{
  "@odata.context": "https://outlook.office365.com/api/v2.0/$metadata#Me/TaskGroups('AAMkADIyAAAhrbe-AAA%3D')/TaskFolders",
  "value": [
    {
      "@odata.id": "https://outlook.office365.com/api/v2.0/Users('dc2d952a-78ff-4609-b3ae-eb66271747bf@8638a6dc-2d66-40dc-aecb-b2436ec47fc0')/TaskFolders('AAMkADIyAAAhrbPXAAA=')",
      "Id": "AAMkADIyAAAhrbPXAAA=",
      "ChangeKey": "hmM7Eb/jgEec8l3+gkJEawAAIbAOlA==",
      "IsDefaultFolder": false,
      "Name": "Cooking",
      "ParentGroupKey": "63d640cf-946f-4734-9c29-60dda7b76acb"
    }
  ]
}

Aufgabenordner aktualisieren

Minimal benötigter Bereich

Aktualisiert die beschreibbaren Eigenschaften eines Aufgabenordners.

Sie können den Eigenschaftswert Name des Standardaufgabenordners Tasks nicht ändern.

Eine Aufgabenordner-ID ist im Postfach des Benutzers eindeutig.

PATCH https://outlook.office.com/api/v2.0/me/taskfolders('{folder_id}')

Geben Sie im Anforderungstext eine JSON-Darstellung der beschreibbaren Eigenschaften des zu aktualisierenden TaskFolder an.

Antwort

Erfolgsstatuscode: 200 OK

Antworttext: Der aktualisierteTaskFolder.

Beispielanfrage

Das folgende Beispiel ändert den Namen des Aufgabenordners zu Charity work.

PATCH https://outlook.office.com/api/v2.0/me/taskfolders('AAMkADIyAAAhrbPWAAA=')
Content-Type: application/json

{
  "Name": "Charity work"
}

Beispielantwort

Status code: 200 OK

{
  "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/TaskFolders/$entity",
  "@odata.id": "https://outlook.office.com/api/v2.0/Users('dc2d952a-78ff-4609-b3ae-eb66271747bf@8638a6dc-2d66-40dc-aecb-b2436ec47fc0')/TaskFolders('AAMkADIyAAAhrbPWAAA=')",
  "Id": "AAMkADIyAAAhrbPWAAA=",
  "ChangeKey": "hmM7Eb/jgEec8l3+gkJEawAAIbAKfQ==",
  "IsDefaultFolder": false,
  "Name": "Charity work",
  "ParentGroupKey": "0006f0b7-0000-0000-c000-000000000046"
}

Aufgabenordner löschen

Minimal benötigter Bereich

Löscht den angegebenen Aufgabenordner.

Der Versuch, den Standardaufgabenordner Tasks zu löschen, würde HTTP 400 Ungültige Anforderung zurückgeben.

DELETE https://outlook.office.com/api/v2.0/me/taskfolders('{folder_id}')

Antwort

Erfolgsstatuscode: 204 Kein Inhalt

Antworttext: Keine.

Beispielanfrage

DELETE https://outlook.office365.com/api/v2.0/me/taskfolders('AAMkADIyAAAhrbPXAAA=')

Beispielantwort

Status code: 204

Aufgabengruppen erstellen

Minimal benötigter Bereich

Legt eine Aufgabengruppe im Postfach des Benutzers an.

POST https://outlook.office.com/api/v2.0/me/taskgroups

Geben Sie im Anforderungstext eine JSON-Darstellung der zu erstellenden TaskGroup an.

Antwort

Erfolgsstatuscode: 201 Erstellt

Antworttext: Die erstellte TaskGroup.

Beispielanfrage

POST https://outlook.office.com/api/v2.0/me/taskgroups
Content-Type: application/json

{
  "Name": "Leisure tasks"
}

Beispielantwort

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/TaskGroups/$entity",
  "@odata.id": "https://outlook.office.com/api/v2.0/Users('dc2d952a-78ff-4609-b3ae-eb66271747bf@8638a6dc-2d66-40dc-aecb-b2436ec47fc0')/TaskGroups('AAMkADIyAAAhrbe-AAA=')",
  "Id": "AAMkADIyAAAhrbe-AAA=",
  "ChangeKey": "hmM7Eb/jgEec8l3+gkJEawAAIbAGjg==".
  "IsDefaultGroup": false,
  "Name": "Leisure tasks",
  "GroupKey": "63d640cf-946f-4734-9c29-60dda7b76acb"
}

Aufgabengruppen abrufen

Minimal benötigter Bereich

Ruft alle Aufgabengruppen im Postfach des Benutzers ab.

Die Antwort enthält immer die Standardaufgabengruppe My Tasks und alle anderen Aufgabengruppen, die im Postfach erstellt wurden.

GET https://outlook.office.com/api/v2.0/me/taskgroups

Antwort

Erfolgsstatuscode: 200 OK

Antworttext: Eine TaskGroup-Sammlung.

Beispielanfrage

GET https://outlook.office.com/api/v2.0/me/taskgroups

Beispielantwort

Status code: 200

{
  "@odata.context": "https://outlook.office365.com/api/v2.0/$metadata#Me/TaskGroups",
  "value": [
    {
      "@odata.id": "https://outlook.office365.com/api/v2.0/Users('dc2d952a-78ff-4609-b3ae-eb66271747bf@8638a6dc-2d66-40dc-aecb-b2436ec47fc0')/TaskGroups('AAMkADIyAAADJ5pYAAA=')",
      "Id": "AAMkADIyAAADJ5pYAAA=",
      "ChangeKey": "hmM7Eb/jgEec8l3+gkJEawAAInHxLA==",
      "IsDefaultGroup": true,
      "Name": "My Tasks",
      "GroupKey": "0006f0b7-0000-0000-c000-000000000046"
    },
    {
      "@odata.id": "https://outlook.office365.com/api/v2.0/Users('dc2d952a-78ff-4609-b3ae-eb66271747bf@8638a6dc-2d66-40dc-aecb-b2436ec47fc0')/TaskGroups('AAMkADIyAAAhrbe-AAA=')",
      "Id": "AAMkADIyAAAhrbe-AAA=",
      "ChangeKey": "hmM7Eb/jgEec8l3+gkJEawAAInHxKw==",
      "IsDefaultGroup": false,
      "Name": "Leisure Tasks",
      "GroupKey": "63d640cf-946f-4734-9c29-60dda7b76acb"
    }
  ]
}

Aufgabengruppen aktualisieren

Minimal benötigter Bereich

Aktualisiert die beschreibbaren Eigenschaften einer Aufgabengruppe.

PATCH https://outlook.office.com/api/v2.0/me/taskgroups('{group_id}')

Geben Sie im Anforderungstext eine JSON-Darstellung der beschreibbaren Eigenschaften der zu aktualisierenden TaskGroup an, z. B. die Eigenschaft Name.

Antwort

Erfolgsstatuscode: 200 OK

Antworttext: Die aktualisierte Aufgabe.

Beispielanfrage

Das folgende Beispiel ändert den Namen einer Aufgabengruppe zu "Persönliche Aufgaben". Beachten Sie, dass Sie den Namen der Standardaufgabengruppe "Meine Aufgaben" nicht ändern können.

PATCH https://outlook.office.com/api/v2.0/me/taskgroups('AAMkADIyAAAhrbe-AAA=')
Content-Type: application/json

{
  "Name": "Personal Tasks"
}

Beispielantwort

Status code: 200 

{
  "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/TaskGroups/$entity",
  "@odata.id": "https://outlook.office.com/api/v2.0/Users('dc2d952a-78ff-4609-b3ae-eb66271747bf@8638a6dc-2d66-40dc-aecb-b2436ec47fc0')/TaskGroups('AAMkADIyAAAhrbe-AAA=')",
  "Id": "AAMkADIyAAAhrbe-AAA=",
  "ChangeKey": "hmM7Eb/jgEec8l3+gkJEawAAIbAGjw==",
  "IsDefaultGroup": false,
  "Name": "Personal Tasks",
  "GroupKey": "63d640cf-946f-4734-9c29-60dda7b76acb"
}

Aufgabengruppen löschen

Minimal benötigter Bereich

Löscht die angegebene Aufgabengruppe.

Der Versuch, die Standardaufgabengruppe My Tasks zu löschen, würde HTTP 400 Ungültige Anforderung zurückgeben.

DELETE https://outlook.office.com/api/v2.0/me/taskgroups('{group_id}')

Antwort

Erfolgsstatuscode: 204 Kein Inhalt

Antworttext: Die aktualisierte Aufgabe.

Beispielanfrage

DELETE https://outlook.office365.com/api/v2.0/me/taskgroups('AAMkADIyAAAhrbe-AAA=')

Beispielantwort

Status code: 204

Nächste Schritte

Egal, ob Sie bereit sind, eine App zu erstellen oder einfach nur mehr darüber erfahren möchten, wir haben alles im Griff.

Oder erfahren Sie mehr über die Verwendung der Office 365-Plattform: