outlookTask リソースの種類outlookTask resource type

重要

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 アイテム。An Outlook item that can track a work item.

タスクを使用すると、開始日時、期限日時、実際の完了日時、進行状況や状態、定期的かどうか、通知が必要かどうかを追跡できます。You can use a task to track the start, due and actual completion dates and times, its progress or status, whether it's recurring, and requires reminding.

outlookTask リソースの日付関連プロパティには次が含まれます。Date-related properties in the outlookTask resource include the following:

  • completedDateTimecompletedDateTime
  • createdDateTimecreatedDateTime
  • dueDateTimedueDateTime
  • lastModifiedDateTimelastModifiedDateTime
  • reminderDateTimereminderDateTime
  • startDateTimestartDateTime

既定では、POST、GET、PATCH、および complete 操作は、REST 応答の日付関連プロパティを UTC で返します。By default, the POST, GET, PATCH, and complete operations return date-related properties in their REST responses 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. 次の例では、対応する応答の日付関連プロパティが EST で返されています。The following example returns date-related properties in EST in the corresponding response:

Prefer: outlook.timezone="Eastern Standard Time"

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
outlookTask を取得するGet outlookTask outlookTaskoutlookTask ユーザーのメールボックスにある Outlook タスクのプロパティとリレーションシップを取得します。Get the properties and relationships of an Outlook task in the user's mailbox.
更新するUpdate outlookTaskoutlookTask Outlook タスクの書き込み可能なプロパティを変更します。Change writeable properties of an Outlook task.
削除するDelete なしNone ユーザーのメールボックス内の指定されたタスクを削除します。Delete the specified task in the user's mailbox.
完了するComplete outlookTask コレクションoutlookTask collection completedDateTime プロパティを現在の日付に設定し、status プロパティを completed に設定する Outlook タスクを完了します。Complete an Outlook task which sets the completedDateTime property to the current date, and status property to completed.
添付ファイルAttachments
添付ファイルを一覧表示するList attachments attachment コレクションattachment collection Outlook タスクのすべての添付ファイルを取得します。Get all attachments on an Outlook task.
添付ファイルを追加するAdd attachment attachmentattachment タスクへの添付としてファイル、アイテム (メッセージ、イベント、連絡先)、またはファイルへのリンクを追加します。Add a file, item (message, event or contact), or link to a file as an attachment to a task.
拡張プロパティExtended properties
単一値の拡張プロパティを作成するCreate single-value extended property outlookTaskoutlookTask 新規または既存の Outlook タスクに、1 つ以上の単一値の拡張プロパティを作成します。Create one or more single-value extended properties in a new or existing Outlook task.
単一値の拡張プロパティを持つタスクを取得するGet task with single-value extended property outlookTaskoutlookTask $expand または $filter を使用して、単一値の拡張プロパティを含む Outlook タスクを取得します。Get Outlook tasks that contain a single-value extended property by using $expand or $filter.
複数値の拡張プロパティを作成するCreate multi-value extended property outlookTaskoutlookTask 新規または既存の Outlook タスクに、1 つ以上の複数値の拡張プロパティを作成します。Create one or more multi-value extended properties in a new or existing Outlook task.
複数値の拡張プロパティを持つタスクの取得Get task with multi-value extended property outlookTaskoutlookTask $expand を使用して、複数値の拡張プロパティを含む Outlook タスクを取得します。Get an Outlook task that contains a multi-value extended property by using $expand.

プロパティProperties

プロパティProperty Type 説明Description
assignedToassignedTo StringString Outlook でタスクが割り当てられているユーザーの名前。The name of the person who has been assigned the task. 読み取り専用です。Read-only.
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. 各カテゴリは、ユーザーが定義した outlookCategorydisplayName プロパティに対応しています。Each category corresponds to the displayName property of an outlookCategory that the user has defined.
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 BooleanBoolean タスクに添付ファイルが含まれている場合、true に設定します。Set to true if the task has attachments.
idid StringString タスクの一意識別子。Unique identifier for the certificate. 既定では、アイテムが1つのコンテナー (フォルダーや予定表など) から別のコンテナーに移動すると、この値は変更されます。By default, this value changes when the item is moved from one container (such as a folder or calendar) to another. この動作を変更するにはPrefer: IdType="ImmutableId" 、ヘッダーを使用します。To change this behavior, use the Prefer: IdType="ImmutableId" header. 詳細については、「 Outlook リソースの不変識別子を取得する」を参照してください。See Get immutable identifiers for Outlook resources for more information. 読み取り専用です。既定では、アイテムが1つのコンテナー (フォルダーや予定表など) から別のコンテナーに移動すると、この値は変更されます。By default, this value changes when the item is moved from one container (such as a folder or calendar) to another. この動作を変更するにはPrefer: IdType="ImmutableId" 、ヘッダーを使用します。To change this behavior, use the Prefer: IdType="ImmutableId" header. 詳細については、「 Outlook リソースの不変識別子を取得する」を参照してください。See Get immutable identifiers for Outlook resources for more information.Read-only.
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.

リレーションシップRelationships

リレーションシップRelationship Type 説明Description
attachmentsattachments attachment コレクションattachment collection タスクの fileAttachmentitemAttachmentreferenceAttachment の各添付ファイルのコレクション。The collection of fileAttachment, itemAttachment, and referenceAttachment attachments for the task. 読み取り専用です。Read-only. Null 許容型。Nullable.
multiValueExtendedPropertiesmultiValueExtendedProperties multiValueLegacyExtendedProperty コレクションmultiValueLegacyExtendedProperty collection そのタスクに対して定義された、複数値拡張プロパティのコレクションです。The collection of multi-value extended properties defined for the task. 読み取り専用です。Read-only. Null 許容型。Nullable.
singleValueExtendedPropertiessingleValueExtendedProperties singleValueLegacyExtendedProperty コレクションsingleValueLegacyExtendedProperty collection そのタスクに対して定義された、単一値拡張プロパティのコレクションです。The collection of single-value extended properties defined for the task. 読み取り専用です。Read-only. Null 許容型。Nullable.

JSON 表記JSON representation

以下は、リソースの JSON 表記です。Here is a JSON representation of the resource.

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