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.
Aktualisieren sie die Eigenschaften eines plannerUser-Objekts . Sie können diesen Vorgang verwenden, um der Liste der bevorzugten Pläne eines Benutzers Pläne hinzuzufügen oder daraus zu entfernen und anzugeben, welche Pläne der Benutzer kürzlich angezeigt hat.
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.ReadWrite |
Group.ReadWrite.All |
| Delegiert (persönliches Microsoft-Konto) |
Nicht unterstützt |
Nicht unterstützt |
| Application |
Nicht unterstützt |
Nicht unterstützt |
HTTP-Anforderung
PATCH /me/planner
| Name |
Beschreibung |
| Authorization |
Bearer {code}. Erforderlich. |
| If-Match |
Letzter bekannter ETag-Wert für plannerUser , der aktualisiert werden soll. Erforderlich. |
Anforderungstext
Geben Sie im Anforderungstext die Werte für die relevanten Felder an, die aktualisiert werden sollen. Vorhandene Eigenschaften, die nicht im Anforderungstext enthalten sind, behalten ihre vorherigen Werte bei oder werden basierend auf Änderungen an anderen Eigenschaftswerten neu berechnet. Geben Sie aus Gründen der Leistung vorhandene Werte, die nicht geändert wurden, nicht an.
| Eigenschaft |
Typ |
Beschreibung |
| favoritePlanReferences |
plannerFavoritePlanReferenceCollection |
Änderungen an der Auflistung, die die Verweise auf die Pläne enthält, die der Benutzer als Favorit markiert hat. |
| recentPlanReferences |
plannerRecentPlanReferenceCollection |
Änderungen an der Auflistung, die die Verweise auf die Pläne enthält, die der Benutzer kürzlich angezeigt hat. |
Antwort
Bei erfolgreicher Ausführung gibt die Methode die Antwort und leeren Inhalt zurück 204 No Content . Wenn die Anforderung den Header mit return=representation Präferenz angibtPrefer, gibt diese Methode einen 200 OK Antwortcode und ein aktualisiertes plannerUser-Objekt im Antworttext zurück.
Diese Methode kann einen beliebigen HTTP-Statuscode zurückgeben. Die häufigsten Fehler, die Apps für diese Methode behandeln sollten, sind die Antworten 400, 403, 404, 409 und 412. Weitere Informationen zu diesen Fehlern finden Sie unter Häufige Planner-Fehlerbedingungen.
Beispiel
Anforderung
Das folgende Beispiel zeigt eine Anfrage. Diese Anforderung fügt den Plan "Nächstes Release Discussion" mit der ID "jd8S5gOaFk2S8aWCIAJz42QAAxtD" als Favoriten für den Benutzer hinzu und entfernt den Plan mit der ID "7oTB5aMIAE2rVo-1N-L7RmQAGX2q" aus der Liste der bevorzugten Pläne.
Es aktualisiert auch die letzte Anzeigezeit des Plans "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"
}
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new PlannerUser
{
FavoritePlanReferences = new PlannerFavoritePlanReferenceCollection
{
AdditionalData = new Dictionary<string, object>
{
{
"jd8S5gOaFk2S8aWCIAJz42QAAxtD" , new PlannerFavoritePlanReference
{
OdataType = "#microsoft.graph.plannerFavoritePlanReference",
OrderHint = " !",
PlanTitle = "Next Release Discussion",
}
},
{
"7oTB5aMIAE2rVo-1N-L7RmQAGX2q" , null
},
},
},
RecentPlanReferences = new PlannerRecentPlanReferenceCollection
{
AdditionalData = new Dictionary<string, object>
{
{
"jd8S5gOaFk2S8aWCIAJz42QAAxtD" , new PlannerRecentPlanReference
{
OdataType = "#microsoft.graph.plannerRecentPlanReference",
LastAccessedDateTime = DateTimeOffset.Parse("2018-01-02T22:49:46.155Z"),
PlanTitle = "Next Release Discussion",
}
},
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Planner.PatchAsync(requestBody, (requestConfiguration) =>
{
requestConfiguration.Headers.Add("Prefer", "return=representation");
requestConfiguration.Headers.Add("If-Match", "W/\"JzEtVXNlckRldGFpbHMgQEBAQEBAQEBAQEBAQEBIWCc=\"");
});
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
abstractions "github.com/microsoft/kiota-abstractions-go"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
graphusers "github.com/microsoftgraph/msgraph-beta-sdk-go/users"
//other-imports
)
headers := abstractions.NewRequestHeaders()
headers.Add("Prefer", "return=representation")
headers.Add("If-Match", "W/\"JzEtVXNlckRldGFpbHMgQEBAQEBAQEBAQEBAQEBIWCc=\"")
configuration := &graphusers.ItemPlannerRequestBuilderPatchRequestConfiguration{
Headers: headers,
}
requestBody := graphmodels.NewPlannerUser()
favoritePlanReferences := graphmodels.NewPlannerFavoritePlanReferenceCollection()
additionalData := map[string]interface{}{
jd8S5gOaFk2S8aWCIAJz42QAAxtD := graphmodels.NewPlannerFavoritePlanReference()
orderHint := " !"
jd8S5gOaFk2S8aWCIAJz42QAAxtD.SetOrderHint(&orderHint)
planTitle := "Next Release Discussion"
jd8S5gOaFk2S8aWCIAJz42QAAxtD.SetPlanTitle(&planTitle)
favoritePlanReferences.SetJd8S5gOaFk2S8aWCIAJz42QAAxtD(jd8S5gOaFk2S8aWCIAJz42QAAxtD)
"7oTB5aMIAE2rVo-1N-L7RmQAGX2q" := null
favoritePlanReferences.Set"7oTB5aMIAE2rVo-1N-L7RmQAGX2q"(&"7oTB5aMIAE2rVo-1N-L7RmQAGX2q")
}
favoritePlanReferences.SetAdditionalData(additionalData)
requestBody.SetFavoritePlanReferences(favoritePlanReferences)
recentPlanReferences := graphmodels.NewPlannerRecentPlanReferenceCollection()
additionalData := map[string]interface{}{
jd8S5gOaFk2S8aWCIAJz42QAAxtD := graphmodels.NewPlannerRecentPlanReference()
lastAccessedDateTime , err := time.Parse(time.RFC3339, "2018-01-02T22:49:46.155Z")
jd8S5gOaFk2S8aWCIAJz42QAAxtD.SetLastAccessedDateTime(&lastAccessedDateTime)
planTitle := "Next Release Discussion"
jd8S5gOaFk2S8aWCIAJz42QAAxtD.SetPlanTitle(&planTitle)
recentPlanReferences.SetJd8S5gOaFk2S8aWCIAJz42QAAxtD(jd8S5gOaFk2S8aWCIAJz42QAAxtD)
}
recentPlanReferences.SetAdditionalData(additionalData)
requestBody.SetRecentPlanReferences(recentPlanReferences)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
planner, err := graphClient.Me().Planner().Patch(context.Background(), requestBody, configuration)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
PlannerUser plannerUser = new PlannerUser();
PlannerFavoritePlanReferenceCollection favoritePlanReferences = new PlannerFavoritePlanReferenceCollection();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
PlannerFavoritePlanReference jd8S5gOaFk2S8aWCIAJz42QAAxtD = new PlannerFavoritePlanReference();
jd8S5gOaFk2S8aWCIAJz42QAAxtD.setOdataType("#microsoft.graph.plannerFavoritePlanReference");
jd8S5gOaFk2S8aWCIAJz42QAAxtD.setOrderHint(" !");
jd8S5gOaFk2S8aWCIAJz42QAAxtD.setPlanTitle("Next Release Discussion");
additionalData.put("jd8S5gOaFk2S8aWCIAJz42QAAxtD", jd8S5gOaFk2S8aWCIAJz42QAAxtD);
additionalData.put("7oTB5aMIAE2rVo-1N-L7RmQAGX2q", null);
favoritePlanReferences.setAdditionalData(additionalData);
plannerUser.setFavoritePlanReferences(favoritePlanReferences);
PlannerRecentPlanReferenceCollection recentPlanReferences = new PlannerRecentPlanReferenceCollection();
HashMap<String, Object> additionalData1 = new HashMap<String, Object>();
PlannerRecentPlanReference jd8S5gOaFk2S8aWCIAJz42QAAxtD1 = new PlannerRecentPlanReference();
jd8S5gOaFk2S8aWCIAJz42QAAxtD1.setOdataType("#microsoft.graph.plannerRecentPlanReference");
OffsetDateTime lastAccessedDateTime = OffsetDateTime.parse("2018-01-02T22:49:46.155Z");
jd8S5gOaFk2S8aWCIAJz42QAAxtD1.setLastAccessedDateTime(lastAccessedDateTime);
jd8S5gOaFk2S8aWCIAJz42QAAxtD1.setPlanTitle("Next Release Discussion");
additionalData1.put("jd8S5gOaFk2S8aWCIAJz42QAAxtD", jd8S5gOaFk2S8aWCIAJz42QAAxtD1);
recentPlanReferences.setAdditionalData(additionalData1);
plannerUser.setRecentPlanReferences(recentPlanReferences);
PlannerUser result = graphClient.me().planner().patch(plannerUser, requestConfiguration -> {
requestConfiguration.headers.add("Prefer", "return=representation");
requestConfiguration.headers.add("If-Match", "W/\"JzEtVXNlckRldGFpbHMgQEBAQEBAQEBAQEBAQEBIWCc=\"");
});
const options = {
authProvider,
};
const client = Client.init(options);
const plannerUser = {
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'
}
}
};
await client.api('/me/planner')
.version('beta')
.update(plannerUser);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Users\Item\Planner\PlannerRequestBuilderPatchRequestConfiguration;
use Microsoft\Graph\Beta\Generated\Models\PlannerUser;
use Microsoft\Graph\Beta\Generated\Models\PlannerFavoritePlanReferenceCollection;
use Microsoft\Graph\Beta\Generated\Models\PlannerFavoritePlanReference;
use Microsoft\Graph\Beta\Generated\Models\PlannerRecentPlanReferenceCollection;
use Microsoft\Graph\Beta\Generated\Models\PlannerRecentPlanReference;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new PlannerUser();
$favoritePlanReferences = new PlannerFavoritePlanReferenceCollection();
$additionalData = [
'jd8S5gOaFk2S8aWCIAJz42QAAxtD' => [
'@odata.type' => '#microsoft.graph.plannerFavoritePlanReference',
'orderHint' => ' !',
'planTitle' => 'Next Release Discussion',
],
'7oTB5aMIAE2rVo-1N-L7RmQAGX2q' => null,
];
$favoritePlanReferences->setAdditionalData($additionalData);
$requestBody->setFavoritePlanReferences($favoritePlanReferences);
$recentPlanReferences = new PlannerRecentPlanReferenceCollection();
$additionalData = [
'jd8S5gOaFk2S8aWCIAJz42QAAxtD' => [
'@odata.type' => '#microsoft.graph.plannerRecentPlanReference',
'lastAccessedDateTime' => new \DateTime('2018-01-02T22:49:46.155Z'),
'planTitle' => 'Next Release Discussion',
],
];
$recentPlanReferences->setAdditionalData($additionalData);
$requestBody->setRecentPlanReferences($recentPlanReferences);
$requestConfiguration = new PlannerRequestBuilderPatchRequestConfiguration();
$headers = [
'Prefer' => 'return=representation',
'If-Match' => 'W/"JzEtVXNlckRldGFpbHMgQEBAQEBAQEBAQEBAQEBIWCc="',
];
$requestConfiguration->headers = $headers;
$result = $graphServiceClient->me()->planner()->patch($requestBody, $requestConfiguration)->wait();
Import-Module Microsoft.Graph.Beta.Planner
$params = @{
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"
}
}
}
# A UPN can also be used as -UserId.
Update-MgBetaUserPlanner -UserId $userId -BodyParameter $params -IfMatch W/'"JzEtVXNlckRldGFpbHMgQEBAQEBAQEBAQEBAQEBIWCc="'
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.users.item.planner.planner_request_builder import PlannerRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
from msgraph_beta.generated.models.planner_user import PlannerUser
from msgraph_beta.generated.models.planner_favorite_plan_reference_collection import PlannerFavoritePlanReferenceCollection
from msgraph_beta.generated.models.planner_favorite_plan_reference import PlannerFavoritePlanReference
from msgraph_beta.generated.models.planner_recent_plan_reference_collection import PlannerRecentPlanReferenceCollection
from msgraph_beta.generated.models.planner_recent_plan_reference import PlannerRecentPlanReference
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = PlannerUser(
favorite_plan_references = PlannerFavoritePlanReferenceCollection(
additional_data = {
"jd8_s5g_oa_fk2_s8a_w_c_i_a_jz42_q_a_axt_d" : {
"@odata_type" : "#microsoft.graph.plannerFavoritePlanReference",
"order_hint" : " !",
"plan_title" : "Next Release Discussion",
},
"7o_t_b5a_m_i_a_e2r_vo-1_n-_l7_rm_q_a_g_x2q" : None,
}
),
recent_plan_references = PlannerRecentPlanReferenceCollection(
additional_data = {
"jd8_s5g_oa_fk2_s8a_w_c_i_a_jz42_q_a_axt_d" : {
"@odata_type" : "#microsoft.graph.plannerRecentPlanReference",
"last_accessed_date_time" : "2018-01-02T22:49:46.155Z",
"plan_title" : "Next Release Discussion",
},
}
),
)
request_configuration = RequestConfiguration()
request_configuration.headers.add("Prefer", "return=representation")
request_configuration.headers.add("If-Match", "W/\"JzEtVXNlckRldGFpbHMgQEBAQEBAQEBAQEBAQEBIWCc=\"")
result = await graph_client.me.planner.patch(request_body, request_configuration = request_configuration)
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
{
"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"
}