目標の更新

名前空間: microsoft.graph

重要

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

目標オブジェクトのプロパティを更新します。

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) サポートされていません。 サポートされていません。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション サポートされていません。 サポートされていません。

HTTP 要求

PATCH /me/planner/plans_v2/{planId}/goals/{goalId}
PATCH /users/{usersId}/planner/plans_v2/{planId}/goals/{goalId}

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

リクエストの本文には、更新するプロパティの値 のみ を指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。

次の表に、更新できるプロパティを示します。

プロパティ 型 説明
displayName 文字列 目標のタイトル。 必須です。
planId String 目標を含むプランの ID。 必須であり、作成後は変更できません。 必須です。
status plannerGoalStatus 目標の進行状況。 使用可能な値: notStarted、onTrack、behind、atRisk、closed、unknownFutureValue。 省略可能。
priority Int32 目標の優先順位。 必須です。
startDate Date 目標の開始日。 省略可能。
finishDate Date 目標の終了予定日。 省略可能。
notes itemBody 目標に関するその他の詳細またはメモ。 省略可能。
archivalInfo plannerArchivalInfo エンティティがアーカイブされているかどうか、アーカイブされた時期に関する情報。 省略可能。
extensions extensionFieldCollection エンティティに設定されたカスタム表示オプション フィールドの値。 $selectをサポートします。 省略可能。

応答

成功した場合、このメソッドは応答本文で 200 OK 応答コードと更新された 目標 オブジェクトを返します。

例

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/beta/me/planner/plans_v2/{planId}/goals/{goalId}
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.goal",
  "displayName": "Increase customer satisfaction",
  "planId": "b3d9f9a2-3e14-4a4b-9b2b-6b6d9e6a2f31",
  "status": "onTrack",
  "priority": 3,
  "startDate": "2026-01-01",
  "finishDate": "2026-12-31",
  "notes": {
    "@odata.type": "microsoft.graph.itemBody"
  },
  "archivalInfo": {
    "@odata.type": "microsoft.graph.plannerArchivalInfo"
  },
  "extensions": {
    "@odata.type": "microsoft.graph.extensionFieldCollection"
  }
}

応答

次の例は応答を示しています。

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

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

{
  "@odata.type": "#microsoft.graph.goal",
  "id": "9935021b-eda4-2af0-bcc7-8bd400583aa0",
  "displayName": "String",
  "planId": "String",
  "status": "String",
  "priority": "Integer",
  "startDate": "Date",
  "finishDate": "Date",
  "notes": {
    "@odata.type": "microsoft.graph.itemBody"
  },
  "archivalInfo": {
    "@odata.type": "microsoft.graph.plannerArchivalInfo"
  },
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "createdDateTime": "String (timestamp)",
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "capabilities": {
    "@odata.type": "microsoft.graph.goalCapability"
  },
  "extensions": {
    "@odata.type": "microsoft.graph.extensionFieldCollection"
  }
}
  • 最終更新: