outlookTask リソースの種類（非推奨）
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
注意
Outlook tasks API は非推奨となり、2022 年 8 月 20 日にデータの返しを停止しました。 代わりに To Do API を 使用します。
作業アイテムを追跡することができる Outlook アイテム。
タスクを使用して追跡できます。
- 開始日、期限、実際の完了日時。
- タスクの進行状況または状態。
- タスクの繰り返しとアラームの状態。
outlookTask リソースの日付関連プロパティには次が含まれます。
- completedDateTime
- createdDateTime
- dueDateTime
- lastModifiedDateTime
- reminderDateTime
- startDateTime
既定では、POST、GET、PATCH、および complete 操作は、REST 応答の日付関連プロパティを UTC で返します。
Prefer: outlook.timezone ヘッダーを使用して、応答内のすべての日付関連プロパティを UTC 以外のタイム ゾーンで表すことができます。 次の例では、対応する応答の日付関連プロパティが EST で返されています。
Prefer: outlook.timezone="Eastern Standard Time"
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| Get | outlookTask | ユーザーのメールボックスにある Outlook タスクのプロパティとリレーションシップを取得します。 |
| 更新する | outlookTask | Outlook タスクの書き込み可能なプロパティを変更します。 |
| 削除する | なし | ユーザーのメールボックス内の指定されたタスクを削除します。 |
| 完全に削除 | なし | Outlook タスクを完全に削除し、ユーザーのメールボックスの [回復可能なアイテム] フォルダーの [消去] フォルダーに配置します。 |
| 完了する | outlookTask コレクション |
completedDateTime プロパティを現在の日付に、status プロパティをcompletedに設定する Outlook タスクを完了します。 |
| 添付ファイル | ||
| 添付ファイルを一覧表示する | attachment コレクション | Outlook タスクのすべての添付ファイルを取得します。 |
| 添付ファイルを追加する | attachment | タスクへの添付としてファイル、アイテム (メッセージ、イベント、連絡先)、またはファイルへのリンクを追加します。 |
| 拡張プロパティ | ||
| 単一値のプロパティを作成する | outlookTask | 新規または既存の Outlook タスクに、1 つ以上の単一値の拡張プロパティを作成します。 |
| 単一値のプロパティを取得する | outlookTask |
$expand または $filter を使用して、単一値の拡張プロパティを含む Outlook タスクを取得します。 |
| 複数値のプロパティを作成する | outlookTask | 新規または既存の Outlook タスクに、1 つ以上の複数値の拡張プロパティを作成します。 |
| 複数値のプロパティを取得する | outlookTask |
$expand を使用して、複数値の拡張プロパティを含む Outlook タスクを取得します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| assignedTo | String | Outlook でタスクが割り当てられているユーザーの名前。 読み取り専用です。 |
| body | itemBody | 通常はタスクに関する情報を含むタスク本体。 HTML 型のみがサポートされています。 |
| categories | String コレクション | タスクに関連付けられたカテゴリ。 各カテゴリは、ユーザーが定義した outlookCategory の displayName プロパティに対応しています。 |
| changeKey | String | タスクのバージョン。 |
| completedDateTime | dateTimeTimeZone | タスクが終了した日付 (指定のタイム ゾーン)。 |
| createdDateTime | DateTimeOffset | タスクが作成された日時。 既定では、UTC 時間です。 要求ヘッダーでカスタム タイム ゾーンを使用できます。 プロパティの値は、ISO 8601 形式を使用します。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| dueDateTime | dateTimeTimeZone | タスクが終了する予定の日時 (指定のタイム ゾーン)。 |
| hasAttachments | Boolean | タスクに添付ファイルが含まれている場合、true に設定します。 |
| id | String | タスクの一意識別子。
既定では、この値は、アイテムをあるコンテナー (フォルダーや予定表など) から別のコンテナーに移動したときに変更されます。 この動作を変更するには、Prefer: IdType="ImmutableId" ヘッダーを使用します。 詳細については「Outlook リソースの不変識別子を取得する」を参照してください。 読み取り専用です。 |
| importance | 重要度 | イベントの重要度。 可能な値は、low、normal、high です。 |
| isReminderOn | Boolean | ユーザーにタスクを通知するアラートを設定する場合は、true に設定します。 |
| lastModifiedDateTime | DateTimeOffset | タスクが最後に変更された日時。 既定では、UTC 時間です。 要求ヘッダーでカスタム タイム ゾーンを使用できます。 プロパティの値は、ISO 8601 形式を使って表され、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| owner | String | タスクを作成したユーザーの名前。 |
| parentFolderId | String | タスクの親フォルダーの一意の識別子。 |
| recurrence | patternedRecurrence | タスクの繰り返しパターン。 |
| reminderDateTime | dateTimeTimeZone | タスクのアラーム通知を行う日時。 |
| sensitivity | sensitivity | タスクのプライバシーのレベルを示します。 使用可能な値は、normal、personal、private、confidential です。 |
| startDateTime | dateTimeTimeZone | タスクを開始する日付 (指定のタイム ゾーン)。 |
| status | taskStatus | タスクの状態または進行状況を示します。 可能な値は、notStarted、inProgress、completed、waitingOnOthers、deferred です。 |
| subject | String | タスクのタイトルまたは簡単な説明。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| attachments | attachment コレクション | タスクの fileAttachment、itemAttachment、referenceAttachment の各添付ファイルのコレクション。 読み取り専用です。 Null 許容型。 |
| multiValueExtendedProperties | multiValueLegacyExtendedProperty コレクション | そのタスクに対して定義された、複数値拡張プロパティのコレクションです。 読み取り専用です。 Null 許容型。 |
| singleValueExtendedProperties | singleValueLegacyExtendedProperty コレクション | そのタスクに対して定義された、単一値拡張プロパティのコレクションです。 読み取り専用です。 Null 許容型。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"assignedTo": "String",
"body": {"@odata.type": "microsoft.graph.itemBody"},
"categories": ["String"],
"changeKey": "String",
"completedDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"createdDateTime": "String (timestamp)",
"dueDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"hasAttachments": true,
"id": "String (identifier)",
"importance": "string",
"isReminderOn": true,
"lastModifiedDateTime": "String (timestamp)",
"owner": "String",
"parentFolderId": "String",
"recurrence": {"@odata.type": "microsoft.graph.patternedRecurrence"},
"reminderDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"sensitivity": "string",
"startDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"status": "string",
"subject": "String"
}