名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
注意
baseTask 上に構築された To Do API セットは 2022 年 5 月 31 日に非推奨となり、2022 年 8 月 31 日にデータの返しを停止しました。 代わりに todoTask API を使用してください。
追跡して完了できる作業や個人用アイテムなど、タスクを表します。 タスクは、常に基本タスク リストに含まれます。
このリソースでは、以下がサポートされています。
- Open Extensions でカスタム プロパティとしてデータを追加します。
- 変更通知を受信します。
- 差分クエリを使用して、増分の追加、削除、更新を追跡します。
baseTask から継承します。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| List tasks | task コレクション | タスク オブジェクトとそのプロパティの一覧を取得します。 |
| タスクを取得する | task | タスク オブジェクトのプロパティと関係を読み取ります。 |
| タスクを更新する | task | タスク オブジェクトのプロパティを更新します。 |
| タスクを削除する | なし | タスク オブジェクトを削除します。 |
| move | baseTask | メッセージを別のリストに移動します。 |
| checklistItems を一覧表示する | チェックリストアイテム コレクション | checklistItems ナビゲーション プロパティから checklistItem リソースを取得します。 |
| checklistItem を作成する | checklistItem | 新しい checklistItem オブジェクトを作成します。 |
| linkedResources を一覧表示する | コレクションlinkedResource_v2 | linkedResources ナビゲーション プロパティからlinkedResource_v2リソースを取得します。 |
| linkedResource の作成 | linkedResource_v2 | 新しい linkedResource_v2 オブジェクトを作成します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| textbody | itemBody | 通常、タスクに関する情報を含むテキスト形式のタスク本文。 baseTask から継承されます。 |
| bodyLastModifiedDateTime | DateTimeOffset | タスクが最後に変更された日時。 既定では、UTC 時間です。 要求ヘッダーでカスタム タイム ゾーンを使用できます。 プロパティの値は、ISO 8601 形式を使って表され、常に UTC 時間です。 たとえば、2020 年 1 月 1 日の午前 0 時の UTC は、'2020-01-01T00:00:00Z' のようになります。 baseTask から継承されます。 |
| CompletedDateTime | DateTimeOffset | タスクが完了した日付。 baseTask から継承されます。 |
| createdDateTime | DateTimeOffset | タスクが作成された日時。 既定では、UTC 時間です。 要求ヘッダーでカスタム タイム ゾーンを使用できます。 プロパティの値は、ISO 8601 形式を使用します。 たとえば、2020 年 1 月 1 日の午前 0 時の UTC は、'2020-01-01T00:00:00Z' のようになります。 baseTask から継承されます。 |
| displayName | 文字列 | タスクの名前を指定します。 baseTask から継承されます。 |
| dueDateTime | dateTimeTimeZone | タスクが終了する予定の日時 (指定のタイム ゾーン)。 baseTask から継承されます。 |
| id | String | タスクの一意識別子。 既定では、タスクがリストから別のリストに移動されても、この値は変更されません。 baseTask から継承されます。 |
| importance | importance | タスクの重要性。 使用可能な値: low、normal、high。
baseTask から継承されます。 使用可能な値: low、normal、high。 |
| lastModifiedDateTime | DateTimeOffset | タスクが最後に変更された日時。 既定では、UTC 時間です。 要求ヘッダーでカスタム タイム ゾーンを使用できます。 プロパティの値は、ISO 8601 形式を使って表され、常に UTC 時間です。 たとえば、2020 年 1 月 1 日の午前 0 時の UTC は、'2020-01-01T00:00:00Z' のようになります。 baseTask から継承されます。 |
| viewpoint | taskViewpoint | reminderDateTime やカテゴリなど、ユーザー個人用のプロパティ。 baseTask から継承されます。 |
| recurrence | patternedRecurrence | タスクの繰り返しパターン。 baseTask から継承されます。 |
| startDateTime | dateTimeTimeZone | タスクを開始する日付 (指定のタイム ゾーン)。 baseTask から継承されます。 |
| status | taskStatus_v2 | タスクの状態または進行状況を示します。 指定できる値は、 notStarted、 inProgress、 completed、unknownFutureValue です。
baseTask から継承されます。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| checklistItems | チェックリストアイテム コレクション | タスクにリンクされている checklistItems のコレクション。 baseTask から継承されます。 |
| extensions | extension コレクション | タスクに定義されているオープン拡張機能のコレクション。 baseTask から継承されます。 |
| linkedResources | コレクションlinkedResource_v2 | タスクにリンクされたリソースのコレクション。 baseTask から継承されます。 |
| parentList | baseTaskList | タスクを含むリスト。 baseTask から継承されます。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@odata.type": "#microsoft.graph.task",
"textBody": "String",
"createdDateTime": "String (timestamp)",
"lastModifiedDateTime": "String (timestamp)",
"bodyLastModifiedDateTime": "String (timestamp)",
"completedDateTime": "String (timestamp)",
"dueDateTime": {
"@odata.type": "microsoft.graph.dateTimeTimeZone"
},
"startDateTime": {
"@odata.type": "microsoft.graph.dateTimeTimeZone"
},
"importance": "String",
"recurrence": {
"@odata.type": "microsoft.graph.patternedRecurrence"
},
"displayName": "String",
"status": "String",
"viewpoint": {
"@odata.type": "microsoft.graph.taskViewpoint"
},
"id": "String (identifier)"
}