Update plannertaskUpdate plannertask

plannertask オブジェクトのプロパティを更新します。Update the properties of plannertask object.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) Group.ReadWrite.AllGroup.ReadWrite.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication サポートされていません。Not supported.

HTTP 要求HTTP request

PATCH /planner/tasks/{id}

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

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.
If-MatchIf-Match 更新する plannerTask の最後の既知の ETag 値。必須。Last known ETag value for the plannerTask to be updated. Required.

要求本文Request body

要求本文で、更新する関連フィールドの値を指定します。要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。最適なパフォーマンスを得るためには、変更されていない既存の値を含めないでください。In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.

プロパティProperty Type 説明Description
appliedCategoriesappliedCategories plannerAppliedCategoriesplannerAppliedCategories タスクが適用されているカテゴリ。可能な値については、「適用されるカテゴリ」を参照してください。The categories to which the task has been applied. See applied Categories for possible values.
assigneePriorityassigneePriority StringString リスト ビューでこの種類の項目の順序付けに使用するヒント。形式は「プランナーでの順序のヒントの使用」で定義されています。Hint used to order items of this type in a list view. The format is defined in Using order hints in Planner.
assignmentsassignments plannerAssignmentsplannerAssignments タスクが割り当てられているユーザーのセット。The set of users the task is assigned to.
bucketIdbucketId StringString タスクが属するバケット id。Bucket id to which the task belongs. バケットは、タスクが存在している計画に含まれている必要があります。The bucket needs to be in the plan that the task is in. 28 文字長で、大文字と小文字の区別があります。It is 28 characters long and case-sensitive. 書式検証はサービスによって行われます。Format validation is done on the service.
conversationThreadIdconversationThreadId StringString タスク内の会話のスレッド ID。これは、グループ内に作成された会話スレッド オブジェクトの ID です。Thread id of the conversation on the task. This is the id of the conversation thread object created in the group.
dueDateTimedueDateTime DateTimeOffsetDateTimeOffset タスクが期限切れになる日時。Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、必ず UTC 時間です。たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、次のようになります。'2014-01-01T00:00:00Z'Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'
orderHintorderHint StringString リスト ビューでこの種類の項目の順序付けに使用するヒント。形式は「プランナーでの順序のヒントの使用」で定義されています。Hint used to order items of this type in a list view. The format is defined in Using order hints in Planner.
percentCompletepercentComplete Int32Int32 タスクの完了の割合。100 に設定すると、タスクが完了したと見なされます。Percentage of task completion. When set to 100, the task is considered completed.
startDateTimestartDateTime DateTimeOffsetDateTimeOffset タスクが開始される日時。Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、必ず UTC 時間です。たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、次のようになります。'2014-01-01T00:00:00Z'Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'
titletitle StringString タスクのタイトル。Title of the task.

応答Response

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で更新された plannerTask オブジェクトを返します。If successful, this method returns a 200 OK response code and updated plannerTask object in the response body.

このメソッドは、いずれかの HTTP 状態コードを返します。このメソッドでアプリが処理する最も一般的なエラーは、400、403、404、409、412 応答です。これらのエラーの詳細については、「一般的なプランナーのエラー条件」を参照してください。This method can return any of the HTTP status codes. The most common errors that apps should handle for this method are the 400, 403, 404, 409, and 412 responses. For more information about these errors, see Common Planner error conditions.

Example

要求Request

以下は、要求の例です。Here is an example of the request.

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

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

以下は、応答の例です。注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

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