plannerUser を更新する

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

plannerUser オブジェクトの プロパティを更新 します。 この操作を使用すると、ユーザーのお気に入りのプランリストにプランを追加または削除したり、ユーザーが最近表示したプランを示したりできます。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	Group.ReadWrite, Group.Readwrite.All
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	サポートされていません。

HTTP 要求

PATCH /me/planner

オプションの要求ヘッダー

名前	説明
Authorization	ベアラー {code}。 必須です。
If-Match	plannerUser が更新される最後の既知の ETag 値。 必須です。

要求本文

要求本文で、更新する関連フィールドの値を指定します。 要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。 最適なパフォーマンスを得るために、変更されていない既存の値を含めないでください。

プロパティ	種類	説明
favoritePlanReferences	plannerFavoritePlanReferenceCollection	ユーザーがお気に入りとしてマークしたプランへの参照を含むコレクションに対する変更。
recentPlanReferences	plannerRecentPlanReferenceCollection	ユーザーが最近表示したプランへの参照を含むコレクションに対する変更。

応答

成功した場合、このメソッドは応答と 204 No Content 空のコンテンツを返します。 要求に優先してヘッダーを指定した場合、このメソッドは応答コードと、応答本文で更新 Prefer return=representation された 200 OK plannerUser オブジェクトを返します。

このメソッドは、いずれかの HTTP 状態コードを返します。このメソッドでアプリが処理する最も一般的なエラーは、400、403、404、409、412 応答です。これらのエラーの詳細については、「一般的なプランナーのエラー条件」を参照してください。

例

要求

要求の例を次に示します。 この要求は、ユーザーのお気に入りとして ID "jd8S5gOaFk2S8aWCIAJz42QAAxtD" を含むプラン "Next Release Discussion" を追加し、お気に入りのプランリストから ID "7oTB5aMIAE2rVo-1N-L7RmQAGX2q" を含むプランを削除します。 また、プラン "jd8S5gOaFk2S8aWCIAJz42QAAAxtD" の最後の表示時刻も更新されます。

HTTP

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"
    }
  }
}

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var plannerUser = new PlannerUser
{
    FavoritePlanReferences = new PlannerFavoritePlanReferenceCollection
    {
        AdditionalData = new Dictionary<string, object>()
        {
            {"jd8S5gOaFk2S8aWCIAJz42QAAxtD", "{\"@odata.type\":\"#microsoft.graph.plannerFavoritePlanReference\",\"orderHint\":\" !\",\"planTitle\":\"Next Release Discussion\"}"},
            {"7oTB5aMIAE2rVo-1N-L7RmQAGX2q", "null"}
        }
    },
    RecentPlanReferences = new PlannerRecentPlanReferenceCollection
    {
        AdditionalData = new Dictionary<string, object>()
        {
            {"jd8S5gOaFk2S8aWCIAJz42QAAxtD", "{\"@odata.type\":\"#microsoft.graph.plannerRecentPlanReference\",\"lastAccessedDateTime\":\"2018-01-02T22:49:46.155Z\",\"planTitle\":\"Next Release Discussion\"}"}
        }
    }
};

await graphClient.Me.Planner
    .Request()
    .Header("Prefer","return=representation")
    .Header("If-Match","W/\"JzEtVXNlckRldGFpbHMgQEBAQEBAQEBAQEBAQEBIWCc=\"")
    .UpdateAsync(plannerUser);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ 版で使用できるすべての種類、プロパティ、API はサポートされていません。 SDK を使用してベータ API にアクセスする方法の詳細については、「Microsoft Graph SDK とベータ API を使用する」を参照してください。

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

JavaScript

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);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ 版で使用できるすべての種類、プロパティ、API はサポートされていません。 SDK を使用してベータ API にアクセスする方法の詳細については、「Microsoft Graph SDK とベータ API を使用する」を参照してください。

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.NewPlannerUser()
favoritePlanReferences := msgraphsdk.NewPlannerFavoritePlanReferenceCollection()
requestBody.SetFavoritePlanReferences(favoritePlanReferences)
favoritePlanReferences.SetAdditionalData(map[string]interface{}{
    "7oTB5aMIAE2rVo-1N-L7RmQAGX2q": nil,
}
recentPlanReferences := msgraphsdk.NewPlannerRecentPlanReferenceCollection()
requestBody.SetRecentPlanReferences(recentPlanReferences)
recentPlanReferences.SetAdditionalData(map[string]interface{}{
}
headers := map[string]string{
    "Prefer": "return=representation"
    "If-Match": "W/"JzEtVXNlckRldGFpbHMgQEBAQEBAQEBAQEBAQEBIWCc=""
}
options := &msgraphsdk.PlannerRequestBuilderPatchRequestConfiguration{
    Headers: headers,
}
graphClient.Me().Planner().PatchWithRequestConfigurationAndResponseHandler(requestBody, options, nil)

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ 版で使用できるすべての種類、プロパティ、API はサポートされていません。 SDK を使用してベータ API にアクセスする方法の詳細については、「Microsoft Graph SDK とベータ API を使用する」を参照してください。

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

PowerShell

Import-Module Microsoft.Graph.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-MgUserPlanner -UserId $userId -BodyParameter $params

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ 版で使用できるすべての種類、プロパティ、API はサポートされていません。 SDK を使用してベータ API にアクセスする方法の詳細については、「Microsoft Graph SDK とベータ API を使用する」を参照してください。

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

応答の例を次に示します。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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"
}