Outlooktask) を更新するUpdate outlooktask

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

Outlook タスクの書き込み可能なプロパティを変更します。Change writable properties of an Outlook task.

CompletedDateTimeプロパティは、完全なアクションによって、または明示的に PATCH 操作によって設定できます。The completedDateTime property can be set by the complete action, or explicitly by a PATCH operation. PATCH を使用してcompletedDateTimeを設定する場合は、状態completed同様にに設定してください。If you use PATCH to set completedDateTime, make sure you set status to completed as well.

既定では、この操作 (および POST、GET、および完了タスク操作) は、日付関連プロパティを UTC で返します。By default, this operation (and the POST, GET, and complete task operations) returns date-related properties in UTC. Prefer: outlook.timezone ヘッダーを使用して、応答内のすべての日付関連プロパティを UTC 以外のタイム ゾーンで表すことができます。You can use the Prefer: outlook.timezone header to have all the date-related properties in the response represented in a time zone different than UTC.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) Tasks.ReadWriteTasks.ReadWrite
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) Tasks.ReadWriteTasks.ReadWrite
アプリケーションApplication サポートされていません。Not supported.

HTTP 要求HTTP request

PATCH /me/outlook/tasks/{id}
PATCH /users/{id|userPrincipalName}/outlook/tasks/{id}

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.
優先: outlook.timezonePrefer: outlook.timezone 応答の時間プロパティのタイムゾーンを指定します。このヘッダーが指定されていない場合は、UTC になります。Specifies the time zone for time properties in the response, which would be in UTC if this header is not specified. 省略可能。Optional.

要求本文Request body

要求本文で、更新する関連フィールドの値を指定します。要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。最適なパフォーマンスを得るためには、変更されていない既存の値を含めないでください。In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.

プロパティProperty Type 説明Description
bodybody itemBodyitemBody 通常はタスクに関する情報を含むタスク本体。HTML 型のみがサポートされていることに注意してください。The task body that typically contains information about the task. Note that only HTML type is supported.
categoriescategories String コレクションString collection タスクに関連付けられたカテゴリ。The categories associated with the task.
changeKeychangeKey StringString タスクのバージョン。The version of the task.
completedDateTimecompletedDateTime dateTimeTimeZonedateTimeTimeZone タスクが終了した日付 (指定のタイム ゾーン)。The date in the specified time zone that the task was finished.
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset タスクが作成された日時。The date and time when the task was created. 既定では、UTC 時間です。By default, it is in UTC. 要求ヘッダーでカスタム タイム ゾーンを使用できます。You can provide a custom time zone in the request header. プロパティの値は、ISO 8601 形式を使用します。The property value uses ISO 8601 format. たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、'2014-01-01T00:00:00Z' のようになります。For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
dueDateTimedueDateTime dateTimeTimeZonedateTimeTimeZone タスクが終了する予定の日時 (指定のタイム ゾーン)。The date in the specified time zone that the task is to be finished.
hasAttachmentshasAttachments ブール値Boolean タスクに添付ファイルが含まれている場合、true に設定します。Set to true if the task has attachments.
importanceimportance stringstring イベントの重要度。The importance of the event. 可能な値は、lownormalhigh です。Possible values are: low, normal, high.
isReminderOnisReminderOn BooleanBoolean ユーザーにタスクを通知するアラートを設定する場合は、true に設定します。Set to true if an alert is set to remind the user of the task.
lastModifiedDateTimelastModifiedDateTime DateTimeOffsetDateTimeOffset タスクが最後に変更された日時。The date and time when the task was last modified. 既定では、UTC 時間です。By default, it is in UTC. 要求ヘッダーでカスタム タイム ゾーンを使用できます。You can provide a custom time zone in the request header. プロパティの値は、ISO 8601 形式を使って表され、常に UTC 時間です。The property value uses ISO 8601 format and is always in UTC time. たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、'2014-01-01T00:00:00Z' のようになります。For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
ownerowner StringString タスクを作成したユーザーの名前。The name of the person who created the task.
parentFolderIdparentFolderId StringString タスクの親フォルダーの一意の識別子。The unique identifier for the task's parent folder.
recurrencerecurrence patternedRecurrencepatternedRecurrence タスクの繰り返しパターン。The recurrence pattern for the task.
reminderDateTimereminderDateTime dateTimeTimeZonedateTimeTimeZone タスクのアラーム通知を行う日時。The date and time for a reminder alert of the task to occur.
sensitivitysensitivity stringstring タスクのプライバシーのレベルを示します。Indicates the level of privacy for the task. 使用可能な値は、normalpersonalprivateconfidential です。Possible values are: normal, personal, private, confidential.
startDateTimestartDateTime dateTimeTimeZonedateTimeTimeZone タスクを開始する日付 (指定のタイム ゾーン)。The date in the specified time zone when the task is to begin.
statusstatus stringstring タスクの状態または進行状況を示します。Indicates the state or progress of the task. 可能な値は、notStartedinProgresscompletedwaitingOnOthersdeferred です。Possible values are: notStarted, inProgress, completed, waitingOnOthers, deferred.
subjectsubject StringString タスクのタイトルまたは簡単な説明。A brief description or title of the task.

応答Response

成功した場合、このメソッド200 OKは応答コードと、応答本文で更新されたoutlooktaskオブジェクトを返します。If successful, this method returns a 200 OK response code and updated outlookTask object in the response body.

Example

要求Request

次の例では、 dueDateTimeプロパティを変更Prefer: outlook.timezoneし、ヘッダーを使用して、応答の日付関連プロパティを東部標準時 (EST) で表現するように指定しています。The following example modifies the dueDateTime property and uses the Prefer: outlook.timezone header to specify expressing the date-related properties in the response in Eastern Standard Time (EST).

PATCH https://graph.microsoft.com/beta/me/outlook/tasks/AAMkADA1MTHgwAAA=
Prefer: outlook.timezone="Eastern Standard Time"
Content-type: application/json
Content-length: 76

{
  "dueDateTime":  {
      "dateTime": "2016-05-06T16:00:00",
      "timeZone": "Eastern Standard Time"
  }
}

応答Response

以下は、応答の例です。注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 376

{
    "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"

}