名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
Microsoft 365 の Planner タスクを表します。 プランナー タスクは プラン に含まれており、プラン内の バケット に割り当てることができます。 各タスク オブジェクトには、タスクに関する詳細情報を含めることができる 詳細 オブジェクトがあります。 グループ、プラン、およびタスクの関係の詳細は、 Planner REST APIの使用を参照してください。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| Create | plannerTask | plannerTask オブジェクトを作成します。 |
| Get | plannerTask | plannerTask オブジェクトのプロパティと関係を読み取ります。 |
| Update | plannerTask | plannerTask オブジェクトを更新します。 |
| Delete | なし | plannerTask オブジェクトを削除します。 |
| Get delta | plannerTask コレクション | リソース コレクション全体の完全な読み取りを実行することなく、plannerPlan で新しく作成、更新、または削除された plannerTask オブジェクトを取得するか、サインインしたユーザーに割り当てます。 |
| List messages | plannerTaskChatMessage コレクション | plannerTask に関連付けられているチャット メッセージを取得します。 |
| メッセージの作成 | plannerTaskChatMessage | Planner タスクで新しいチャット メッセージを作成します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| 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 です。 |
| goalIds | String collection | 読み取り専用です。 タスクに関連付けられている目標の ID。 |
| hasChat | ブール型 | 読み取り専用です。 この値は、タスクにチャット メッセージが関連付けられている場合に true されます。 それ以外の場合は、 false。 |
| hasDescription | Boolean | 読み取り専用です。 この値は、タスクの詳細オブジェクトの説明が空でない場合に true されます。 それ以外の場合は、 false。 |
| id | String | 読み取り専用です。 タスクの一意識別子。 このプロパティの値は 28 文字で、大文字と小文字が区別されます。 書式検証はサービスによって行われます。 |
| isArchived | Boolean | 読み取り専用です。
true に設定すると、タスクはアーカイブされます。 アーカイブされたタスクは読み取り専用です。 |
| isOnMyDay | ブール型 | このタスクを MyDay ビューに表示するかどうかを指定します。
trueの場合は、タスクが表示されます。 |
| isOnMyDayLastModifiedDate | Date | 読み取り専用です。 タスクが MyDay に追加または削除される日付。 |
| lastModifiedBy | identitySet | 読み取り専用です。 これを最後に変更したユーザー ID。 |
| lastModifiedDateTime | DateTimeOffset | 読み取り専用。 最終更新日時。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| orderHint | String | リスト ビューでこの種類のアイテムを並べ替えるために使用されるヒント。 詳細については、「 Planner での順序ヒントの使用」を参照してください。 |
| percentComplete | Int32 | タスクの完了率。
100 に設定すると、タスクは完了です。 |
| priority | Int32 | タスクの優先度。 有効な値は、 0 から 10 の間です。 値が大きいほど優先度が低いことを示します。 たとえば、 0 の優先度は最も高く、 10 の優先度は最も低くなります。 現在、Planner では、 0 と 1 の値は "緊急"、 2 と 3 、 4 は "重要"、 5、 6、 7 は "中"、 8、 9、 10 は "低" と解釈されます。 現在、プランナーでは値 1 が "緊急"、 3 が "重要"、 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 | Planner タスクを完了するには、フォームの一部またはすべてを送信する必要があります。 |
| approvalCompletion | 承認が必要です。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| assignedToTaskBoardFormat | plannerAssignedToTaskBoardTaskFormat | 読み取り専用です。 Null 許容型。 assignedTo によってグループ化されている場合に、タスク ボード ビューにタスクを正しくレンダリングするために使用されます。 |
| bucketTaskBoardFormat | plannerBucketTaskBoardTaskFormat | 読み取り専用です。 Null 許容型。 バケット別にグループ化されている場合に、タスク ボード ビューにタスクを正しくレンダリングするために使用されます。 |
| 詳細 | plannerTaskDetails | 読み取り専用です。 Null 許容型。 タスクの詳細。 |
| messages | plannerTaskChatMessage コレクション | 読み取り専用です。 Null 許容型。 タスクに関連付けられている Chat メッセージ。 |
| 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)",
"goalIds": ["String"],
"hasChat": "Boolean",
"hasDescription": "Boolean",
"id": "String (identifier)",
"isOnMyDay": "Boolean",
"isOnMyDayLastModifiedDate": "Date",
"lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
"lastModifiedDateTime": "String (timestamp)",
"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"
}