plannerTask の更新

  • [アーティクル]

名前空間: microsoft.graph

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

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ❌

アクセス許可

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

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) Tasks.ReadWrite Group.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション Tasks.ReadWrite.All 注意事項なし。

HTTP 要求

PATCH /planner/tasks/{id}

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
Content-Type application/json. Required.
If-Match plannerTask が更新される最後の既知の ETag 値。 必須です。

要求本文

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

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

プロパティ 型 説明
appliedCategories plannerAppliedCategories タスクが適用されているカテゴリ。 使用可能な値については、「 appliedCategories」を参照してください。
assigneePriority String リスト ビューでこの種類の項目を注文するために使用されるヒント。 形式は、Plannerでの順序ヒントの使用に関するページで定義されています。
assignments plannerAssignments タスクが割り当てられているユーザーのセット。
bucketId String タスクが属しているバケット ID。 バケットは、タスクが存在している計画に含まれている必要があります。 値の長さは 28 文字で、大文字と小文字が区別されます。 書式検証はサービスによって行われます。
conversationThreadId String タスク上の会話のスレッド ID。 これは、グループ内に作成された会話スレッド オブジェクトの ID です。
dueDateTime DateTimeOffset タスクが期限切れになる日時。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。
orderHint String リスト ビューでこの種類の項目を注文するために使用されるヒント。 形式は、Plannerでの順序ヒントの使用に関するページで定義されています。
priority Int32 タスクの優先度。 有効な値の範囲は、値が大きくなると優先順位010が低くなります (0 の優先度が最も高く、10 の優先度が最も低くなります)。 現在、Plannerは、値 0および1 を「緊急」、2、3、および4を「重要」、5、6、および7を「中」と解釈します。 8、9、および10は「低」です。 さらに、Planner は、値 1 を「緊急」、3 を「重要」、5 を「中」、9 を「低」に設定します。
percentComplete Int32 タスク完了の割合。 に 100設定すると、タスクは完了と見なされます。
startDateTime DateTimeOffset タスクが開始される日時。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。
title String タスクのタイトル。

注:

Plannerにレプリケートされる Project タスクの場合、percentComplete プロパティのみを更新できます。

応答

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

このメソッドは、 任意の HTTP 状態コードを返すことができます。 この方法でアプリが処理する必要がある最も一般的なエラーは、400、403、404、409、および 412 の応答です。 これらのエラーの詳細については、「一般的なPlannerエラー条件」を参照してください。

例

要求

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

PATCH https://graph.microsoft.com/v1.0/planner/tasks/{task-id}
Content-type: application/json
Prefer: return=representation
If-Match: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="

{
  "assignments": {
    "fbab97d0-4932-4511-b675-204639209557": {
      "@odata.type": "#microsoft.graph.plannerAssignment",
      "orderHint": "N9917 U2883!"
    }
  },
  "appliedCategories": {
    "category3": true,
    "category4": false
  }
}

応答

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

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

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

{
  "createdBy": {
    "user": {
      "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
    }
  },
  "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
  "bucketId": "gcrYAaAkgU2EQUvpkNNXLGQAGTtu",
  "title": "title-value",
  "orderHint": "9223370609546166567W",
  "assigneePriority": "90057581\"",
  "createdDateTime": "2015-03-24T18:36:49.2407981Z",
  "assignments": {
    "6463a5ce-2119-4198-9f2a-628761df4a62": {
      "@odata.type": "#microsoft.graph.plannerAssignment",
      "assignedBy": {
        "user": {
          "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
        }
      },
      "assignedDateTime": "2015-03-25T18:38:21.956Z",
      "orderHint": "N9917"
    },
    "fbab97d0-4932-4511-b675-204639209557": {
      "@odata.type": "#microsoft.graph.plannerAssignment",
      "assignedBy": {
        "user": {
          "id": "1e9955d2-6acd-45bf-86d3-b546fdc795eb"
        }
      },
      "assignedDateTime": "2017-04-24T22:40:44.5665917",
      "orderHint": "RWk1"
    },
    "aaa27244-1db4-476a-a5cb-004607466324": {
      "@odata.type": "#microsoft.graph.plannerAssignment",
      "assignedBy": {
        "user": {
          "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
        }
      },
      "assignedDateTime": "2015-03-25T18:38:21.956Z",
      "orderHint": "U2883"
    }
  },
  "appliedCategories": {
    "category3": true,
    "category5": true,
    "category6": true,
  },
  "id":"01gzSlKkIUSUl6DF_EilrmQAKDhh",
  "priority": 5
}