plannerTask: delta

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Rufen Sie neu erstellte, aktualisierte oder gelöschte Aufgaben entweder in einem Planner-Plan ab oder weisen Sie sie dem angemeldeten Benutzer zu, ohne die gesamte Ressourcensammlung vollständig lesen zu müssen. Weitere Informationen finden Sie unter Verwenden der Deltaabfrage zum Nachverfolgen von Änderungen in Microsoft Graph-Daten.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ✅ ✅ ❌

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Tasks.Read Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application Tasks.Read.All Nicht verfügbar.

HTTP-Anforderung

GET /planner/tasks/delta
GET /me/planner/tasks/delta

Abfrageparameter

Das Nachverfolgen von Änderungen führt zu einer Runde von mindestens einem Delta-Funktionsaufruf. Wenn Sie Abfrageparameter (außer $deltaToken und $skipToken) verwenden, müssen Sie sie in der ursprünglichen Delta-Anforderung angeben. Microsoft Graph codiert automatisch alle angegebenen Parameter in den Tokenteil der in der Antwort enthaltenen @odata.nextLink- oder @odata.deltaLink-URL. Sie müssen alle Abfrageparameter nur einmal im Vorfeld angeben. Kopieren Sie in nachfolgenden Anforderungen die @odata.nextLink URL @odata.deltaLink oder aus der vorherigen Antwort, und wenden Sie sie an. Diese URL enthält bereits die codierten Parameter.

Abfrageparameter Typ Beschreibung
$deltaToken string Ein Zustandstoken, das in der @odata.deltaLink URL des vorherigen Delta-Funktionsaufrufs für dieselbe Ressourcensammlung zurückgegeben wird und den Abschluss dieser Runde der Änderungsnachverfolgung angibt. Speichern Sie die gesamte @odata.deltaLink URL, einschließlich dieses Tokens, und wenden Sie sie in der ersten Anforderung der nächsten Runde der Änderungsnachverfolgung für diese Sammlung an.
$skipToken string Ein Zustandstoken, das in der @odata.nextLink URL des vorherigen Delta-Funktionsaufrufs zurückgegeben wurde und angibt, dass weitere Änderungen in derselben Ressourcensammlung nachverfolgt werden müssen.

Wenn Sie diese API mit reinen Anwendungsberechtigungen aufrufen, müssen Sie die Anforderung mithilfe eines $filter Abfrageparameters des Typs planId eq '{planId}', auf einen einzelnen Plan begrenzen und einen $select Abfrageparameter einschließen, der genau diese drei Nicht-ID-Eigenschaften angibt: percentComplete, assignmentsund creationSource. Beispiel: $select=percentComplete,assignments,creationSource. Die Auswahl einer anderen Anzahl von Nicht-ID-Eigenschaften gibt eine 405 Method Not Allowed Antwort zurück, und die Auswahl von drei anderen Nicht-ID-Eigenschaften gibt eine 403 Forbidden Antwort zurück. Die id-Eigenschaft wird immer zurückgegeben und kann eingeschlossen $select werden, ohne auf diesen Grenzwert anzurechnen.

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Antwort

Bei erfolgreicher Ausführung gibt diese Funktion einen 200 OK Antwortcode und eine plannerTask-Auflistung im Antworttext zurück.

Beispiele

Beispiel 1: Abrufen von Delta für Aufgaben in einem PlannerPlan

Das folgende Beispiel zeigt eine Anforderung für das Delta für plannerTask-Objekte in einem plannerPlan.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/beta/planner/tasks/delta

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerTask",
  "@odata.deltaLink": "https://graph.microsoft.com/beta/planner/plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/tasks?%24expand=details&%24deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
  "value": [
    {
      "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
      "createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
      "createdByApp": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3",
      "createdByAsIdentitySet": {
        "user": {
          "@odata.type": "#microsoft.taskServices.identity",
          "displayName": null,
          "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
        },
        "application": {
          "@odata.type": "#microsoft.taskServices.identity",
          "displayName": null,
          "id": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3"
        }
      },
      "userContentLastModifiedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
      "userContentLastModifiedByApp": null,
      "userContentLastModifiedByAsIdentitySet": {
        "user": {
          "@odata.type": "#microsoft.taskServices.identity",
          "displayName": null,
          "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
        }
      },
      "planId": "-W4K7hIak0WlAwgJCn1sEWQABgjH",
      "bucketId": "iz1mmIxX7EK0Yj7DmRsMs2QAEDXH",
      "title": "Testing",
      "orderHint": "8585371316800245114P\\",
      "assigneePriority": "8585371316123370883",
      "focusDateTime": null,
      "percentComplete": 0,
      "startDateTime": null,
      "createdDateTime": "2022-09-29T18:14:25.6091874Z",
      "userContentLastModifiedDate": "2022-09-29T18:14:33.1404924Z",
      "dueDateTime": null,
      "recurrence": null,
      "hasDescription": false,
      "previewType": "automatic",
      "completedDateTime": null,
      "completedBy": null,
      "completedByApp": null,
      "completedByAsIdentitySet": null,
      "referenceCount": 0,
      "checklistItemCount": 0,
      "activeChecklistItemCount": 0,
      "appliedCategories": {},
      "assignments": {
        "b40c85a0-1a66-4fa3-932f-cc9249ce8c29": {
          "@odata.type": "#microsoft.taskServices.assignment",
          "assignedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
          "assignedByAppId": null,
          "assignedByAsIdentitySet": {
            "user": {
              "@odata.type": "#microsoft.taskServices.identity",
              "displayName": null,
              "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
            }
          },
          "assignedDateTime": "2022-09-29T18:14:33.1404924Z",
          "orderHint": "8585371316723527019PX",
          "createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
          "createdByAppId": null,
          "createdByAsIdentitySet": {
            "user": {
              "@odata.type": "#microsoft.taskServices.identity",
              "displayName": null,
              "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
            }
          }
        }
      },
      "conversationThreadId": null,
      "priority": 5,
      "creationSource": {
        "publication": null,
        "externalSource": null
      },
      "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
      "version": "1-Task  @@@@@@@@@@@@@@@H",
      "details": {
        "@odata.etag": "W/\"JzEtVGFza0RldGFpbHMgQEBAQEBAQEBAQEBAQEBARCc=\"",
        "description": "",
        "notes": null,
        "previewType": "automatic",
        "references": {},
        "checklist": {},
        "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
        "version": "1-TaskDetails @@@@@@@@@@@@@@@D"
      }
    }
  ]
}

Beispiel 2: Abrufen von Delta für Aufgaben, die einem Benutzer zugewiesen sind

Das folgende Beispiel zeigt eine Anforderung für das Delta für plannerTask-Objekte , die einem Benutzer zugewiesen sind.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/beta/me/planner/tasks/delta

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerTask",
  "@odata.deltaLink": "https://graph.microsoft.com/beta/me/planner/tasks/delta?%24expand=details&%24deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
  "value": [
    {
      "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
      "createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
      "createdByApp": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3",
      "createdByAsIdentitySet": {
        "user": {
          "@odata.type": "#microsoft.taskServices.identity",
          "displayName": null,
          "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
        },
        "application": {
          "@odata.type": "#microsoft.taskServices.identity",
          "displayName": null,
          "id": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3"
        }
      },
      "userContentLastModifiedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
      "userContentLastModifiedByApp": null,
      "userContentLastModifiedByAsIdentitySet": {
        "user": {
          "@odata.type": "#microsoft.taskServices.identity",
          "displayName": null,
          "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
        }
      },
      "planId": "-W4K7hIak0WlAwgJCn1sEWQABgjH",
      "bucketId": "iz1mmIxX7EK0Yj7DmRsMs2QAEDXH",
      "title": "Testing",
      "orderHint": "8585371316800245114P\\",
      "assigneePriority": "8585371316123370883",
      "focusDateTime": null,
      "percentComplete": 0,
      "startDateTime": null,
      "createdDateTime": "2022-09-29T18:14:25.6091874Z",
      "userContentLastModifiedDate": "2022-09-29T18:14:33.1404924Z",
      "dueDateTime": null,
      "recurrence": null,
      "hasDescription": false,
      "previewType": "automatic",
      "completedDateTime": null,
      "completedBy": null,
      "completedByApp": null,
      "completedByAsIdentitySet": null,
      "referenceCount": 0,
      "checklistItemCount": 0,
      "activeChecklistItemCount": 0,
      "appliedCategories": {},
      "assignments": {
        "b40c85a0-1a66-4fa3-932f-cc9249ce8c29": {
          "@odata.type": "#microsoft.taskServices.assignment",
          "assignedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
          "assignedByAppId": null,
          "assignedByAsIdentitySet": {
            "user": {
              "@odata.type": "#microsoft.taskServices.identity",
              "displayName": null,
              "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
            }
          },
          "assignedDateTime": "2022-09-29T18:14:33.1404924Z",
          "orderHint": "8585371316723527019PX",
          "createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
          "createdByAppId": null,
          "createdByAsIdentitySet": {
            "user": {
              "@odata.type": "#microsoft.taskServices.identity",
              "displayName": null,
              "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
            }
          }
        }
      },
      "conversationThreadId": null,
      "priority": 5,
      "creationSource": {
        "publication": null,
        "externalSource": null
      },
      "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
      "version": "1-Task  @@@@@@@@@@@@@@@H",
      "details": {
        "@odata.etag": "W/\"JzEtVGFza0RldGFpbHMgQEBAQEBAQEBAQEBAQEBARCc=\"",
        "description": "",
        "notes": null,
        "previewType": "automatic",
        "references": {},
        "checklist": {},
        "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
        "version": "1-TaskDetails @@@@@@@@@@@@@@@D"
      }
    }
  ]
}

Beispiel 3: Abrufen von Delta für Aufgaben in einem PlannerPlan mithilfe von reinen Anwendungsberechtigungen

Das folgende Beispiel zeigt eine Anforderung, die nur Anwendungsberechtigungen verwendet. Wie im Abschnitt Abfrageparameter beschrieben, muss die Anforderung mithilfe eines $filter Abfrageparameters auf einen einzelnen Plan eingegrenzt werden und mithilfe eines $select Abfrageparameters genau die percentCompleteEigenschaften , assignmentsund creationSource auswählen.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/beta/planner/tasks/delta?$filter=planId eq '-W4K7hIak0WlAwgJCn1sEWQABgjH'&$select=percentComplete,assignments,creationSource

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#plannerTask",
  "@odata.deltaLink": "https://graph.microsoft.com/beta/planner/plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/tasks?%24select=percentComplete,assignments,creationSource&%24deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
  "value": [
    {
      "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
      "percentComplete": 0,
      "assignments": {
        "b40c85a0-1a66-4fa3-932f-cc9249ce8c29": {
          "@odata.type": "#microsoft.taskServices.assignment",
          "assignedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
          "assignedDateTime": "2022-09-29T18:14:33.1404924Z",
          "orderHint": "8585371316723527019PX"
        }
      },
      "creationSource": {
        "publication": null,
        "externalSource": null
      },
      "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l"
    }
  ]
}