Skip to content

outlooktask.md

Latest commit

 

History

History
146 lines (126 loc) · 8.09 KB

outlooktask.md

File metadata and controls

146 lines (126 loc) · 8.09 KB
title outlookTask resource type
description An Outlook item that can track a work item.
author mashriv
ms.localizationpriority high
ms.subservice outlook
doc_type resourcePageType
toc.title Outlook task (deprecated)
ms.date 08/23/2024

outlookTask resource type (deprecated)

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

[!INCLUDE outlooktask-deprecate-allup]

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.
  • The progress or status of the task.
  • The recurrence and reminder statuses of the task.

Date-related properties in the outlookTask resource include the following:

  • completedDateTime
  • createdDateTime
  • dueDateTime
  • lastModifiedDateTime
  • reminderDateTime
  • startDateTime

By default, the POST, GET, PATCH, and complete operations return date-related properties in their REST responses in 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. The following example returns date-related properties in EST in the corresponding response:

Prefer: outlook.timezone="Eastern Standard Time"

Methods

Method Return Type Description
Get outlookTask Get the properties and relationships of an Outlook task in the user's mailbox.
Update outlookTask Change writeable properties of an Outlook task.
Delete None Delete the specified task in the user's mailbox.
Permanently delete None Permanently delete an Outlook task and place it in the Purges folder in the Recoverable Items folder in the user's mailbox.
Complete outlookTask collection Complete an Outlook task that sets the completedDateTime property to the current date, and status property to completed.
Attachments
List attachments attachment collection Get all attachments on an Outlook task.
Add attachment attachment Add a file, item (message, event or contact), or link to a file as an attachment to a task.
Extended properties
Create single-value property outlookTask Create one or more single-value extended properties in a new or existing Outlook task.
Get single-value property outlookTask Get Outlook tasks that contain a single-value extended property by using $expand or $filter.
Create multi-value property outlookTask Create one or more multi-value extended properties in a new or existing Outlook task.
Get multi-value property outlookTask Get an Outlook task that contains a multi-value extended property by using $expand.

Properties

Property Type Description
assignedTo String The name of the person who has been assigned the task in Outlook. Read-only.
body itemBody The task body that typically contains information about the task. Only the HTML type is supported.
categories String collection The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory that the user has defined.
changeKey String The version of the task.
completedDateTime dateTimeTimeZone The date in the specified time zone that the task was finished.
createdDateTime DateTimeOffset The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
dueDateTime dateTimeTimeZone The date in the specified time zone that the task is to be finished.
hasAttachments Boolean Set to true if the task has attachments.
id String Unique identifier for the task. [!INCLUDE outlook-beta-id] Read-only.
importance importance The importance of the event. The possible values are: low, normal, high.
isReminderOn Boolean Set to true if an alert is set to remind the user of the task.
lastModifiedDateTime DateTimeOffset The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
owner String The name of the person who created the task.
parentFolderId String The unique identifier for the task's parent folder.
recurrence patternedRecurrence The recurrence pattern for the task.
reminderDateTime dateTimeTimeZone The date and time for a reminder alert of the task to occur.
sensitivity sensitivity Indicates the level of privacy for the task. The possible values are: normal, personal, private, confidential.
startDateTime dateTimeTimeZone The date in the specified time zone when the task is to begin.
status taskStatus Indicates the state or progress of the task. The possible values are: notStarted, inProgress, completed, waitingOnOthers, deferred.
subject String A brief description or title of the task.

Relationships

Relationship Type Description
attachments attachment collection The collection of fileAttachment, itemAttachment, and referenceAttachment attachments for the task. Read-only. Nullable.
multiValueExtendedProperties multiValueLegacyExtendedProperty collection The collection of multi-value extended properties defined for the task. Read-only. Nullable.
singleValueExtendedProperties singleValueLegacyExtendedProperty collection The collection of single-value extended properties defined for the task. Read-only. Nullable.

JSON representation

The following JSON representation shows the resource type.

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