Mettre à jour un objet plannertask

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Mettez à jour les propriétés de l’objet plannertask.

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ✅ ✅ ❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) Tasks.ReadWrite Group.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Tasks.ReadWrite.All Non disponible.

Requête HTTP

PATCH /planner/tasks/{id}

En-têtes de demande facultatifs

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
If-Match Dernière valeur ETag connue pour plannerTask à mettre à jour. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez uniquement les valeurs des propriétés à mettre à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conservent leurs valeurs précédentes ou sont recalculées en fonction des modifications apportées à d’autres valeurs de propriété.

Le tableau suivant spécifie les propriétés qui peuvent être mises à jour.

Propriété Type Description
appliedCategories plannerAppliedCategories Spécifie les catégories auxquelles la tâche du Planificateur a été appliquée. Voir les catégories appliquées pour connaître les valeurs possibles.
assigneePriority String Conseil utilisé pour ordonner des éléments de ce type dans un affichage sous forme de liste. Le format est défini dans Utilisation des indicateurs d’ordre dans le Planificateur.
Affectations plannerAssignments Ensemble d’utilisateurs auxquels la tâche est affectée.
bucketId Chaîne ID du compartiment auquel appartient la tâche. Le compartiment doit se trouver dans le plan où se trouve la tâche. Cette valeur a 28 caractères et est sensible à la casse. Une validation du format est effectuée sur le service.
conversationThreadId String ID de thread de la conversation sur la tâche, ID de l’objet de thread de conversation créé dans le groupe.
dueDateTime DateTimeOffset Date et heure auxquelles la tâche doit être effectuée. Le type d’horodatage représente les informations de date et d’heure au moyen du format ISO 8601. Il est toujours au format d’heure UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z.
isOnMyDay Booléen Indique si cette tâche doit être affichée dans la vue MyDay. Si true, il affiche la tâche.
orderHint String Conseil utilisé pour ordonner des éléments de ce type dans un affichage sous forme de liste. Le format est défini comme indiqué ici.
percentComplete Int32 Pourcentage d’achèvement des tâches. Lorsque la valeur est , 100la tâche est considérée comme terminée.
planId Chaîne ID du plan auquel appartient la tâche.
priorité Int32 Priorité de la tâche. La plage de valeurs valide est comprise entre 0 et 10 (inclus), la valeur croissante étant de priorité inférieure (0 a la priorité la plus élevée et 10 la priorité la plus faible). Actuellement, Planificateur interprète les valeurs 0 et 1 comme « urgentes 2 », et 43 et comme « importantes », 65, et 7 comme « moyennes », et 8, 9et 10 comme « faibles ». Actuellement, Planificateur définit la valeur 1 pour « urgent », 3 « important », 5 « moyen » et 9 « faible ».
recurrence plannerTaskRecurrence La périodicité de la tâche, si elle est définie. Facultatif.
startDateTime DateTimeOffset Date et heure de début de la tâche. Le type d’horodatage représente les informations de date et d’heure au moyen du format ISO 8601. Il est toujours au format d’heure UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z.
title Chaîne Titre de la tâche.

Remarque

Pour les tâches de projet qui sont répliquées dans le Planificateur, seule la propriété percentComplete peut être mise à jour.

Réponse

En cas de succès, cette méthode renvoie un 204 No Content code de réponse et un contenu vide. Si la requête spécifie l’en-tête Prefer avec une return=representation préférence, cette méthode renvoie un 200 OK code de réponse et un objet plannerTask mis à jour dans le corps de la réponse.

Cette méthode peut renvoyer n’importe quel code d’status HTTP. Les erreurs les plus courantes que les applications doivent gérer pour cette méthode sont les réponses 400, 403, 404, 409 et 412. Pour plus d’informations sur ces erreurs, voir Conditions d’erreur courantes du planificateur.

Exemple

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/beta/planner/tasks/01gzSlKkIUSUl6DF_EilrmQAKDhh
Content-type: application/json
Prefer: return=representation
If-Match: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="

{
  "assignments": {
    "fbab97d0-4932-4511-b675-204639209557": {
      "@odata.type": "#microsoft.graph.plannerAssignment",
      "orderHint": "N9917 U2883!"
    }
  },
  "appliedCategories": {
    "category3": true,
    "category4": false
  },
  "recurrence": {
    "schedule": {
      "pattern": {
        "type": "daily",
        "interval": 3
      },
      "patternStartDateTime": "2022-02-22T02:10:33Z"
    }
  }
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

{
  "createdBy": {
    "user": {
      "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
    }
  },
  "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
  "bucketId": "gcrYAaAkgU2EQUvpkNNXLGQAGTtu",
  "title": "title-value",
  "orderHint": "9223370609546166567W",
  "assigneePriority": "90057581\"",
  "createdDateTime": "2015-03-24T18:36:49.2407981Z",
  "assignments": {
    "6463a5ce-2119-4198-9f2a-628761df4a62": {
      "@odata.type": "#microsoft.graph.plannerAssignment",
      "assignedBy": {
        "user": {
          "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
        }
      },
      "assignedDateTime": "2015-03-25T18:38:21.956Z",
      "orderHint": "N9917"
    },
    "fbab97d0-4932-4511-b675-204639209557": {
      "@odata.type": "#microsoft.graph.plannerAssignment",
      "assignedBy": {
        "user": {
          "id": "1e9955d2-6acd-45bf-86d3-b546fdc795eb"
        }
      },
      "assignedDateTime": "2017-04-24T22:40:44.5665917",
      "orderHint": "RWk1"
    },
    "aaa27244-1db4-476a-a5cb-004607466324": {
      "@odata.type": "#microsoft.graph.plannerAssignment",
      "assignedBy": {
        "user": {
          "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
        }
      },
      "assignedDateTime": "2015-03-25T18:38:21.956Z",
      "orderHint": "U2883"
    }
  },
  "appliedCategories": {
    "category3": true,
    "category5": true,
    "category6": true
  },
  "id": "01gzSlKkIUSUl6DF_EilrmQAKDhh",
  "recurrence": {
    "@odata.type": "#microsoft.graph.plannerTaskRecurrence",
    "seriesId": "qOqWwPLt4U-LIsWV5ByUuA",
    "occurrenceId": 1,
    "previousInSeriesTaskId": null,
    "nextInSeriesTaskId": null,
    "schedule": {
      "@odata.type": "#microsoft.graph.plannerRecurrenceSchedule",
      "pattern": {
        "odata.type": "#microsoft.graph.recurrencePattern",
        "type": "daily",
        "interval": 3,
        "firstDayOfWeek": "sunday",
        "dayOfMonth": 0,
        "daysOfWeek": [],
        "index": "first",
        "month": 0
      },
      "patternStartDateTime": "2022-02-22T02:10:33Z",
      "nextOccurrenceDateTime": "2022-02-25T02:10:33Z"
    },
    "recurrenceStartDateTime": "2022-02-22T02:10:33Z"
  }
}