名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
プラン オブジェクトのプロパティを更新します。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ❌ | ❌ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | サポートされていません。 | サポートされていません。 |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | サポートされていません。 | サポートされていません。 |
HTTP 要求
PATCH /planner/plans_v2/{planId}
要求ヘッダー
| 名前 | 説明 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
| Content-Type | application/json. 必須です。 |
要求本文
リクエストの本文には、更新するプロパティの値 のみ を指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。
次の表に、更新できるプロパティを示します。
| プロパティ | 型 | 説明 |
|---|---|---|
| displayName | String | プランのタイトル。 必須です。 |
| コンテナー | planContainer | プランを所有するグループ、Teams チャネル、またはユーザーを識別します。 必須であり、作成後は変更できません。 省略可能。 |
| calendar | planCalendar | プランの稼働時間カレンダー設定。 省略可能。 |
| archivalInfo | plannerArchivalInfo | エンティティがアーカイブされているかどうか、アーカイブされた時期に関する情報。 省略可能。 |
| planView | planView | カテゴリ定義を含む、プラン スコープのビュー設定。 省略可能。 |
| contentSensitivityLabelAssignment | contentSensitivityLabelAssignment | プランに関連付けられているコンテンツに割り当てられた秘密度ラベル。 省略可能。 |
| hasChat | ブール型 | プランに関連付けられているチャットがあるかどうかを示します。 省略可能。 |
| duration | Int32 | プランの期間 (日数)。 省略可能。 |
| sharedWithContainers | plannerSharedWithContainer コレクション | プランが共有されているコンテナー (追加のグループやチャネルなど) のリスト。 省略可能。 |
| extensions | extensionFieldCollection | エンティティに設定されたカスタム表示オプション フィールドの値。 $selectをサポートします。 省略可能。 |
応答
成功した場合、このメソッドは応答本文で 200 OK 応答コードと更新された プラン オブジェクトを返します。
例
要求
次の例は要求を示しています。
PATCH https://graph.microsoft.com/beta/planner/plans_v2/{planId}
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.plan",
"displayName": "Product Launch Plan",
"container": {
"@odata.type": "microsoft.graph.planContainer"
},
"calendar": {
"@odata.type": "microsoft.graph.planCalendar"
},
"archivalInfo": {
"@odata.type": "microsoft.graph.plannerArchivalInfo"
},
"planView": {
"@odata.type": "microsoft.graph.planView"
},
"contentSensitivityLabelAssignment": {
"@odata.type": "microsoft.graph.contentSensitivityLabelAssignment"
},
"hasChat": true,
"duration": 30,
"sharedWithContainers": [
{
"@odata.type": "microsoft.graph.plannerSharedWithContainer"
}
],
"extensions": {
"@odata.type": "microsoft.graph.extensionFieldCollection"
}
}
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.plan",
"id": "da037802-c736-af41-ff32-789862c95bd9",
"displayName": "String",
"container": {
"@odata.type": "microsoft.graph.planContainer"
},
"calendar": {
"@odata.type": "microsoft.graph.planCalendar"
},
"creationInfo": {
"@odata.type": "microsoft.graph.creationInfo"
},
"lastModifiedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"lastModifiedDateTime": "String (timestamp)",
"archivalInfo": {
"@odata.type": "microsoft.graph.plannerArchivalInfo"
},
"planView": {
"@odata.type": "microsoft.graph.planView"
},
"contentSensitivityLabelAssignment": {
"@odata.type": "microsoft.graph.contentSensitivityLabelAssignment"
},
"hasChat": "Boolean",
"duration": "Integer",
"sharedWithContainers": [
{
"@odata.type": "microsoft.graph.plannerSharedWithContainer"
}
],
"capabilities": {
"@odata.type": "microsoft.graph.planCapability"
},
"extensions": {
"@odata.type": "microsoft.graph.extensionFieldCollection"
}
}