Mettre à jour plannerUser

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 .

Mettre à jour les propriétés d’un objet plannerUser . Vous pouvez utiliser cette opération pour ajouter ou supprimer des plans de la liste des plans favoris d’un utilisateur, et pour indiquer les plans que l’utilisateur a récemment consultés.

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 Non prise en charge. Non prise en charge.

Requête HTTP

PATCH /me/planner

En-têtes de demande facultatifs

Nom Description
Autorisation Porteur {code}. Obligatoire.
If-Match Dernière valeur ETag connue pour plannerUser à mettre à jour. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez les valeurs pour les champs appropriés qui doivent être mis à 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é. Pour de meilleures performances, n’incluez pas de valeurs existantes qui n’ont pas été modifiées.

Propriété Type Description
favoritePlanReferences plannerFavoritePlanReferenceCollection Modifications apportées à la collection contenant les références aux plans que l’utilisateur a marqués comme favoris.
recentPlanReferences plannerRecentPlanReferenceCollection Modifications apportées à la collection contenant les références aux plans récemment consultés par l’utilisateur.

Réponse

En cas de succès, cette méthode retourne une 204 No Content réponse et un contenu vide. Si la requête spécifie Prefer un en-tête avec return=representation préférence, cette méthode renvoie un 200 OK code de réponse et un objet plannerUser 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. Cette demande ajoute le plan « Next Release Discussion » avec l’ID « jd8S5gOaFk2S8aWCIAJz42QAAxtD » en tant que favori pour l’utilisateur, et supprime le plan avec l’ID « 7oTB5aMIAE2rVo-1N-L7RmQAGX2q » de la liste des plans favoris. Elle met également à jour la dernière heure de consultation du plan « jd8S5gOaFk2S8aWCIAJz42QAAxtD ».

PATCH https://graph.microsoft.com/beta/me/planner
Content-type: application/json
Prefer: return=representation
If-Match: W/"JzEtVXNlckRldGFpbHMgQEBAQEBAQEBAQEBAQEBIWCc="

{
  "favoritePlanReferences": {
    "jd8S5gOaFk2S8aWCIAJz42QAAxtD": {
      "@odata.type": "#microsoft.graph.plannerFavoritePlanReference",
      "orderHint": " !",
      "planTitle": "Next Release Discussion"
    },
    "7oTB5aMIAE2rVo-1N-L7RmQAGX2q": null
  },
  "recentPlanReferences": {
    "jd8S5gOaFk2S8aWCIAJz42QAAxtD": {
      "@odata.type": "#microsoft.graph.plannerRecentPlanReference",
      "lastAccessedDateTime": "2018-01-02T22:49:46.155Z",
      "planTitle": "Next Release Discussion"
    }
  }
}

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

{
  "favoritePlanReferences": {
    "jd8S5gOaFk2S8aWCIAJz42QAAxtD": {
      "@odata.type": "#microsoft.graph.plannerFavoritePlanReference",
      "orderHint": "8586866870001551087",
      "planTitle": "Next Release Discussion"
    },
    "uZWtCtli30CGoWLIWSat1mQAC0ai": {
      "@odata.type": "#microsoft.graph.plannerFavoritePlanReference",
      "orderHint": "8586888705198093378",
      "planTitle": "Product Support"
    }
  },
  "recentPlanReferences": {
    "jd8S5gOaFk2S8aWCIAJz42QAAxtD": {
      "@odata.type": "#microsoft.graph.plannerRecentPlanReference",
      "lastAccessedDateTime": "2018-01-02T22:49:46.155Z",
      "planTitle": "Next Release Discussion"
    },
    "XYE5pqNJu0uuRC2PM4ZQrmQAF2Pn": {
      "@odata.type": "#microsoft.graph.plannerRecentPlanReference",
      "lastAccessedDateTime": "2018-01-01T19:39:17.57Z",
      "planTitle": "Success Metrics"
    }
  },
  "id": "-YPnMJRiIUSKFyaVjYEkBWQAAc47"
}