Outlooktask の更新 (非推奨)
名前空間: microsoft.graph
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
注意
Outlook タスク API は、2022 年 8 月 20 日に廃止され、データを返さなくなります。 新しい To Do API をご使用ください。 詳細については、「パブリックプレビューでの To Do API 」を参照してください。
Outlook タスクの書き込み可能なプロパティを変更します。
completedDateTime プロパティは、完全なアクションによって設定することも、PATCH 操作によって明示的に設定することもできます。 PATCH を使用して completedDateTime を設定する場合は、 必ず状態 も に completed
設定してください。
既定では、この操作 (および POST、GET、および 完全な タスク操作) は、UTC で日付関連のプロパティを返します。 Prefer: outlook.timezone
ヘッダーを使用して、応答内のすべての日付関連プロパティを UTC 以外のタイム ゾーンで表すことができます。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。
アクセス許可の種類 | 最小特権アクセス許可 | 特権の高いアクセス許可 |
---|---|---|
委任 (職場または学校のアカウント) | Tasks.ReadWrite | 注意事項なし。 |
委任 (個人用 Microsoft アカウント) | Tasks.ReadWrite | 注意事項なし。 |
アプリケーション | サポートされていません。 | サポートされていません。 |
HTTP 要求
PATCH /me/outlook/tasks/{id}
PATCH /users/{id|userPrincipalName}/outlook/tasks/{id}
要求ヘッダー
名前 | 説明 |
---|---|
Authorization | ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。 |
優先: outlook.timezone | 応答のタイム プロパティのタイム ゾーンを指定します。これは、このヘッダーが指定されていない場合は UTC になります。 省略可能です。 |
要求本文
要求本文で、更新する関連フィールドの値を指定します。 要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。 最適なパフォーマンスを得るためには、変更されていない既存の値を含めないでください。
プロパティ | 型 | 説明 |
---|---|---|
body | itemBody | 通常はタスクに関する情報を含むタスク本体。 HTML 型のみがサポートされていることに注意してください。 |
categories | String コレクション | タスクに関連付けられたカテゴリ。 |
changeKey | String | タスクのバージョン。 |
completedDateTime | dateTimeTimeZone | タスクが終了した日付 (指定のタイム ゾーン)。 |
createdDateTime | DateTimeOffset | タスクが作成された日時。 既定では、UTC 時間です。 要求ヘッダーでカスタム タイム ゾーンを使用できます。 プロパティの値は、ISO 8601 形式を使用します。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
dueDateTime | dateTimeTimeZone | タスクが終了する予定の日時 (指定のタイム ゾーン)。 |
hasAttachments | Boolean | タスクに添付ファイルが含まれている場合、true に設定します。 |
importance | string | イベントの重要度。 可能な値は、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 | string | タスクのプライバシーのレベルを示します。 使用可能な値は、normal 、personal 、private 、confidential です。 |
startDateTime | dateTimeTimeZone | タスクを開始する日付 (指定のタイム ゾーン)。 |
status | string | タスクの状態または進行状況を示します。 可能な値は、notStarted 、inProgress 、completed 、waitingOnOthers 、deferred です。 |
subject | String | タスクのタイトルまたは簡単な説明。 |
応答
成功した場合、このメソッドは応答コードを 200 OK
返し、応答本文で outlookTask オブジェクトを更新します。
例
要求
次の例では dueDateTime プロパティを変更し、 ヘッダーを Prefer: outlook.timezone
使用して、東部標準時 (EST) の応答で日付関連のプロパティを指定します。
PATCH https://graph.microsoft.com/beta/me/outlook/tasks/AAMkADA1MTHgwAAA=
Prefer: outlook.timezone="Eastern Standard Time"
Content-type: application/json
{
"dueDateTime": {
"dateTime": "2016-05-06T16:00:00",
"timeZone": "Eastern Standard Time"
}
}
応答
次の例は応答を示しています。 注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "AAMkADA1MTHgwAAA=",
"createdDateTime": "2016-04-22T18:19:18.9526004-04:00",
"lastModifiedDateTime": "2016-04-22T18:38:20.5541528-04:00",
"changeKey": "1/KC9Vmu40G3DwB6Lgs7MAAAIW9XXg==",
"categories": [
],
"assignedTo": null,
"body": {
"contentType": "text",
"content": ""
},
"completedDateTime": null,
"dueDateTime": {
"dateTime": "2016-05-06T00:00:00.0000000",
"timeZone": "Eastern Standard Time"
},
"hasAttachments":false,
"importance": "normal",
"isReminderOn": false,
"owner": "Administrator",
"parentFolderId": "AQMkADA1MTIBEgAAAA==",
"recurrence": null,
"reminderDateTime": null,
"sensitivity": "normal",
"startDateTime": {
"dateTime": "2016-05-03T00:00:00.0000000",
"timeZone": "Eastern Standard Time"
},
"status": "notStarted",
"subject": "Shop for children's weekend"
}
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示