Update plannertask

名前空間: microsoft.graph

重要

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

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

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

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

アクセス許可

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

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

HTTP 要求

PATCH /planner/tasks/{id}

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

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
If-Match 更新する plannerTask の最後の既知の ETag 値。 必須です。

要求本文

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

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

プロパティ 型 説明
appliedCategories plannerAppliedCategories Planner タスクが適用されたカテゴリを指定します。 有効な値は、 適用されたカテゴリ を参照してください。
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 です。
isOnMyDay ブール型 このタスクを MyDay ビューに表示するかどうかを指定します。 trueの場合は、タスクが表示されます。
orderHint String リスト ビューでこの種類のアイテムを並べ替えるために使用されるヒント。 フォーマットの定義は 、次に概説されています。
percentComplete Int32 タスクの完了率。 100 に設定すると、タスクは完了したと見なされます。
planId String タスクが属している計画 ID。
priority Int32 タスクの優先度。 値の有効な範囲は 0 から 10 (両端を含む) で、値が増加すると優先度が低くなります (0 の優先度が最も高く、 10 の優先度が最も低くなります)。 現在、Planner では、 0 と 1 の値は "緊急"、 2 と 3 と 4 は "重要"、 5、 6、 7 は "中"、 8、 9、 10 は "低" と解釈されます。 現時点では、Planner では値 1 が "緊急"、 3 が "重要"、 5 が "中"、 9 が "低" に設定されています。
recurrence plannerTaskRecurrence タスクの繰り返し (定義されている場合)。 省略可能。
startDateTime DateTimeOffset タスクが開始される日時。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。
title String タスクのタイトル。

注:

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

応答

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

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

例

要求

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

PATCH https://graph.microsoft.com/beta/planner/tasks/01gzSlKkIUSUl6DF_EilrmQAKDhh
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
  },
  "recurrence": {
    "schedule": {
      "pattern": {
        "type": "daily",
        "interval": 3
      },
      "patternStartDateTime": "2022-02-22T02:10:33Z"
    }
  }
}

応答

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

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

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",
  "recurrence": {
    "@odata.type": "#microsoft.graph.plannerTaskRecurrence",
    "seriesId": "qOqWwPLt4U-LIsWV5ByUuA",
    "occurrenceId": 1,
    "previousInSeriesTaskId": null,
    "nextInSeriesTaskId": null,
    "schedule": {
      "@odata.type": "#microsoft.graph.plannerRecurrenceSchedule",
      "pattern": {
        "odata.type": "#microsoft.graph.recurrencePattern",
        "type": "daily",
        "interval": 3,
        "firstDayOfWeek": "sunday",
        "dayOfMonth": 0,
        "daysOfWeek": [],
        "index": "first",
        "month": 0
      },
      "patternStartDateTime": "2022-02-22T02:10:33Z",
      "nextOccurrenceDateTime": "2022-02-25T02:10:33Z"
    },
    "recurrenceStartDateTime": "2022-02-22T02:10:33Z"
  }
}