名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
Microsoft 365 のプランナー タスクを表します。 プランナー タスクはプランに含まれており、 プラン 内の バケット に割り当てることができます。 各タスク オブジェクトには、タスクに関する詳細情報を含めることができる details オブジェクトがあります。 グループ、プラン、タスク間のリレーションシップの詳細については、「 Planner REST API を使用する」を参照してください。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| Create | plannerTask | plannerTask オブジェクトを作成します。 |
| Get | plannerTask | plannerTask オブジェクトのプロパティとリレーションシップを読み取ります。 |
| Update | plannerTask | plannerTask オブジェクトを更新します。 |
| 削除 | なし | plannerTask オブジェクトを削除します。 |
| Get delta | plannerTask コレクション | plannerPlan で新しく作成、更新、または削除された plannerTask オブジェクトを取得するか、リソース コレクション全体の完全な読み取りを実行することなく、サインインユーザーに割り当てます。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| activeChecklistItemCount | Int32 | 値が false に設定され、不完全な項目を表すチェックリスト項目の数。 |
| appliedCategories | plannerAppliedCategories | タスクが適用されるカテゴリ。 使用可能な値については、「 plannerAppliedCategories リソースの種類 」を参照してください。 |
| archivalInfo | plannerArchivalInfo | 読み取り専用です。 Null 許容型。 タスクをアーカイブまたはアーカイブ解除したユーザーとその理由に関する情報が含まれます。 |
| assigneePriority | String | リスト ビューでこの種類のアイテムを注文するために使用されるヒント。 詳細については、「 Planner での注文ヒントの使用」を参照してください。 |
| assignments | plannerAssignments | タスクが割り当てられている一連の担当者。 |
| bucketId | String | タスクが属しているバケット ID。 バケットは、タスクと同じプランに存在する必要があります。 bucketId プロパティの値は 28 文字で、大文字と小文字が区別されます。 書式検証はサービスによって行われます。 |
| checklistItemCount | Int32 | タスクに存在するチェックリスト項目の数。 |
| completedBy | identitySet | タスクを完了したユーザーの ID。 |
| CompletedDateTime | DateTimeOffset | 読み取り専用。 タスクの 'percentComplete' が '100'に設定されている日付と時刻。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| conversationThreadId | String | タスクの会話のスレッド ID。 これは、グループ内に作成された会話スレッド オブジェクトの ID です。 |
| createdBy | identitySet | タスクを作成したユーザーの ID。 |
| createdDateTime | DateTimeOffset | 読み取り専用。 タスクが作成される日付と時刻。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| creationSource | plannerTaskCreation | タスクの配信元に関する情報。 |
| dueDateTime | DateTimeOffset | タスクの期限となる日付と時刻。 タイムスタンプの種類は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時刻です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| hasDescription | Boolean | 読み取り専用です。 この値は、タスクの details オブジェクトに説明がない場合に true されます。 それ以外の場合は、false。 |
| id | String | 読み取り専用です。 タスクの一意識別子。 このプロパティの値は 28 文字で、大文字と小文字が区別されます。 書式検証はサービスによって行われます。 |
| isArchived | Boolean | 読み取り専用です。
trueに設定すると、タスクはアーカイブされます。 アーカイブされたタスクは読み取り専用です。 |
| isOnMyDay | ブール型 | MyDay ビューにこのタスクを表示するかどうかを示します。
trueすると、タスクが表示されます。 |
| isOnMyDayLastModifiedDate | Date | 読み取り専用です。 MyDay にタスクを追加または削除する日付。 |
| orderHint | String | リスト ビューでこの種類の項目を注文するために使用されるヒント。 詳細については、「Planner n での注文ヒントの使用」を参照してください。 |
| percentComplete | Int32 | タスク完了の割合。
100に設定すると、タスクが完了します。 |
| priority | Int32 | タスクの優先順位。 有効な値は、 0 と 10の間です。包括的です。 値が大きいほど、優先度が低いことを示します。 たとえば、 0 の優先度が最も高く、 10 の優先度が最も低くなります。 現在、planner は 0 値と 1 値を "緊急"、 2 、 3 として解釈し、 4 を "重要"、 5、 6、 7 を "medium"、 8、 9、 10 "low" と解釈しています。 現在、planner は、"緊急" の値 1 、"重要" に 3 、"medium" の 5 、"低" の 9 を設定します。 |
| planId | String | タスクが属している計画 ID。 |
| previewType | String | タスクに表示されるプレビューの種類。 使用可能な値: automatic、noPreview、checklist、description、reference。 |
| recurrence | plannerTaskRecurrence | タスクのアクティブまたは非アクティブな繰り返しを定義します。
null タスクに対して繰り返しが定義されていない場合。 |
| referenceCount | Int32 | タスクに上に存在している外部への参照の数。 |
| specifiedCompletionRequirements | plannerTaskCompletionRequirements |
plannerTask で指定されたすべての要件を示します。 使用可能な値: none、checklistCompletion、unknownFutureValue、formCompletion、approvalCompletion。 読み取り専用です。
Prefer: include-unknown-enum-members要求ヘッダーを使用して、この進化可能な列挙型で次の値を取得します:formCompletion、approvalCompletion。
plannerTaskDetails の plannerTaskCompletionRequirementDetails には、指定された要件の詳細 (存在する場合) があります。 |
| startDateTime | DateTimeOffset | タスクが開始される日時。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| title | String | タスクのタイトル。 |
plannerTaskCompletionRequirements 値
| メンバー | 説明 |
|---|---|
| none | 要件なし。 |
| checklistCompletion | チェックリスト項目の一部または全部をチェックする必要があります。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
| formCompletion | プランナー タスクを完了するには、フォームの一部またはすべてを送信する必要があります。 |
| approvalCompletion | 承認が必要です。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| assignedToTaskBoardFormat | plannerAssignedToTaskBoardTaskFormat | 読み取り専用です。 Null 許容型。 assignedTo でグループ化されたときに、タスク ボード ビューでタスクを正しくレンダリングするために使用されます。 |
| bucketTaskBoardFormat | plannerBucketTaskBoardTaskFormat | 読み取り専用です。 Null 許容型。 バケット別にグループ化されたときにタスク ボード ビューでタスクを正しくレンダリングするために使用されます。 |
| 詳細 | plannerTaskDetails | 読み取り専用です。 Null 許容型。 タスクの詳細。 |
| progressTaskBoardFormat | plannerProgressTaskBoardTaskFormat | 読み取り専用です。 Null 許容型。 進行状況別にグループ化されたときにタスク ボード ビューでタスクを正しくレンダリングするために使用されます。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"activeChecklistItemCount": "Int32",
"appliedCategories": {"@odata.type": "microsoft.graph.plannerAppliedCategories"},
"assigneePriority": "String",
"assignments": {"@odata.type": "microsoft.graph.plannerAssignments"},
"bucketId": "String",
"checklistItemCount": "Int32",
"completedBy": {"@odata.type": "microsoft.graph.identitySet"},
"completedDateTime": "String (timestamp)",
"conversationThreadId": "String",
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"dueDateTime": "String (timestamp)",
"hasDescription": "Boolean",
"id": "String (identifier)",
"isOnMyDay": "Boolean",
"isOnMyDayLastModifiedDate": "Date",
"orderHint": "String",
"percentComplete": "Int32",
"planId": "String",
"previewType": "String",
"priority": "Int32",
"recurrence": {"@odata.type": "microsoft.graph.plannerTaskRecurrence"},
"referenceCount": "Int32",
"specifiedCompletionRequirements": "String",
"startDateTime": "String (timestamp)",
"title": "String"
}