Outlook Tasks service lets you create, read, synchronize, update and delete your tasks that are secured by Azure Active Directory in Office 365 or a Microsoft account.
Status: Production |
Tier: Standard |
Version: 1.0.0 |
Name |
Summary |
List all task folders |
|
Create a task folder |
|
Get a task folder |
|
Update a task folder |
|
List all task groups |
|
Create a task group |
|
Get a task group |
|
Update a task group |
|
List task folders in group |
|
CreateTaskFolderInGroup_V2 (string group_id, TaskFolder body) |
Create a task folder in a task group |
List all tasks |
|
List tasks in folder |
|
Create a task |
|
CreateTaskInFolder_V3 (string folder_id, create-TaskOS body) |
Create a task in folder |
Get a task |
|
Update a task |
|
Delete a task |
|
Complete a task |
|
Get all completed tasks |
|
Get all incomplete tasks |
|
List all task folders |
|
CreateTaskFolder ([Optional]string groupId, TaskFolder body) |
Create a task folder |
List all task groups |
|
Create a task group |
|
List task folders in group |
|
List tasks in folder |
|
List all tasks |
|
Create a task |
|
CreateTaskV2 ([Optional]string folderId, CreateTaskHTMLBody body) |
Create a task (V2) |
Complete a task |
|
Get a task |
|
Mark a task as incomplete |
Name |
Summary |
When a task is added |
|
When a task is completed |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List all task folders
Description: Returns a list of all the task folders in your mailbox.
Syntax:
OutlookTasks.GetAllTaskFolders_V2 ([Optional]string $filter, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
$filter |
string (Filter Items) |
OData $filter. e.g. `contains(Name, 'custom')`. Filterable properties: Name. |
False |
|
$top |
integer (Top Items) |
The number of items in the queried collection to be included in the result. |
False |
|
$skip |
integer (Skip Items) |
The number of items in the queried collection that are to be skipped and not included in the result. This is applied before the $top option. |
False |
Returns:
Summary: Create a task folder
Description: This operation creates a new task folder in the default task group (`My Tasks`) in your mailbox.
Syntax:
OutlookTasks.CreateTaskFolder_V2 (TaskFolder body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
An Outlook task folder. |
True |
Returns:
Summary: Get a task folder
Description: This operation gets a specific task folder.
Syntax:
OutlookTasks.GetTaskFolder (string folder_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
folder_id |
string (Task Folder ID) |
The default 'Tasks' well-known folder name, or a programatic ID of a task folder, unique in the user's mailbox. |
True |
Returns:
Summary: Update a task folder
Description: This operation is used to modify an existing task folder.
Syntax:
OutlookTasks.UpdateTaskFolder (string folder_id, TaskFolder body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
folder_id |
string (Task Folder ID) |
The default 'Tasks' well-known folder name, or a programatic ID of a task folder, unique in the user's mailbox. |
True |
|
body |
|
An Outlook task folder. |
True |
Returns:
Summary: List all task groups
Description: Returns a list of all the task groups in your mailbox.
Syntax:
OutlookTasks.GetAllTaskGroups_V2 ([Optional]string $filter, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
$filter |
string (Filter Items) |
OData $filter. e.g. `contains(Name, 'custom')`. Filterable properties: Name. |
False |
|
$top |
integer (Top Items) |
The number of items in the queried collection to be included in the result. |
False |
|
$skip |
integer (Skip Items) |
The number of items in the queried collection that are to be skipped and not included in the result. This is applied before the $top option. |
False |
Returns:
Summary: Create a task group
Description: This operation creates a new task group in your mailbox.
Syntax:
OutlookTasks.CreateTaskGroup_V2 (TaskGroup body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
An Outlook task group. |
True |
Returns:
Summary: Get a task group
Description: This operation gets a specific task group.
Syntax:
OutlookTasks.GetTaskGroup_V1 (string group_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
group_id |
string (Task Group ID) |
The programatic ID of a task group, unique in the user's mailbox. |
True |
Returns:
Summary: Update a task group
Description: This operation is used to modify an existing task group.
Syntax:
OutlookTasks.UpdateTaskGroup_V1 (string group_id, TaskGroup body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
group_id |
string (Task Group ID) |
The programatic ID of a task group, unique in the user's mailbox. |
True |
|
body |
|
An Outlook task group. |
True |
Returns:
Summary: List task folders in group
Description: Returns a list of all the task folders in the specified task group in your mailbox.
Syntax:
OutlookTasks.GetTaskFoldersInGroup_V2 (string group_id, [Optional]string $filter, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
group_id |
string (Task Group ID) |
The programatic ID of a task group, unique in the user's mailbox. |
True |
|
$filter |
string (Filter Items) |
OData $filter. e.g. `contains(Name, 'custom')`. Filterable properties: Name. |
False |
|
$top |
integer (Top Items) |
The number of items in the queried collection to be included in the result. |
False |
|
$skip |
integer (Skip Items) |
The number of items in the queried collection that are to be skipped and not included in the result. This is applied before the $top option. |
False |
Returns:
Summary: Create a task folder in a task group
Description: This operation creates a new task folder in the specified task group in your mailbox.
Syntax:
OutlookTasks.CreateTaskFolderInGroup_V2 (string group_id, TaskFolder body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
group_id |
string (Task Group ID) |
The programatic ID of a task group, unique in the user's mailbox. |
True |
|
body |
|
An Outlook task folder. |
True |
Returns:
Summary: List all tasks
Description: Returns a list of all your tasks in your mailbox.
Syntax:
OutlookTasks.GetAllTasks_V2 ([Optional]string $filter, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
$filter |
string (Filter Items) |
OData $filter. e.g. To return only incomplete tasks: `Status ne 'Completed'`. e.g. Search by subject: `contains(Subject, 'some text')`. e.g. Return tasks that have been modified after a certain date: `LastModifiedDateTime gt 2020-03-27T19:00:00z`. Common filterable properties: Subject, Status, Categories, Importance, Sensitivity, CreatedDateTime, LastModifiedDateTime, StartDateTime, DueDateTime, CompletedDateTime, HasAttachments. |
False |
|
$top |
integer (Top Items) |
The number of items in the queried collection to be included in the result. |
False |
|
$skip |
integer (Skip Items) |
The number of items in the queried collection that are to be skipped and not included in the result. This is applied before the $top option. |
False |
Returns:
Summary: List tasks in folder
Description: Returns a list of all your tasks in the specified task folder in your mailbox.
Syntax:
OutlookTasks.GetTasksInFolder_V2 (string folder_id, [Optional]string $filter, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
folder_id |
string (Task Folder ID) |
The default 'Tasks' well-known folder name, or a programatic ID of a task folder, unique in the user's mailbox. |
True |
|
$filter |
string (Filter Items) |
OData $filter. e.g. To return only incomplete tasks: `Status ne 'Completed'`. e.g. Search by subject: `contains(Subject, 'some text')`. e.g. Return tasks that have been modified after a certain date: `LastModifiedDateTime gt 2020-03-27T19:00:00z`. Common filterable properties: Subject, Status, Categories, Importance, Sensitivity, CreatedDateTime, LastModifiedDateTime, StartDateTime, DueDateTime, CompletedDateTime, HasAttachments. |
False |
|
$top |
integer (Top Items) |
The number of items in the queried collection to be included in the result. |
False |
|
$skip |
integer (Skip Items) |
The number of items in the queried collection that are to be skipped and not included in the result. This is applied before the $top option. |
False |
Returns:
Summary: Create a task
Description: This operation creates a new task in the default task folder (`Tasks`) in your mailbox.
Syntax:
OutlookTasks.CreateTask_V3 (create-TaskOS body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Summary: Create a task in folder
Description: This operation creates a new task in the specified task folder in your mailbox.
Syntax:
OutlookTasks.CreateTaskInFolder_V3 (string folder_id, create-TaskOS body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
folder_id |
string (Task Folder ID) |
The default 'Tasks' well-known folder name, or a programatic ID of a task folder, unique in the user's mailbox. |
True |
|
body |
|
|
True |
Returns:
Summary: Get a task
Description: This operation gets a specific task.
Syntax:
OutlookTasks.GetTask_V2 (string task_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
task_id |
string (Task ID) |
The programatic task ID, unique in the user's mailbox. |
True |
Returns:
Summary: Update a task
Description: This operation is used to modify an existing task.
Syntax:
OutlookTasks.UpdateTask_V2 (string task_id, patch-TaskOS body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
task_id |
string (Task ID) |
The programatic task ID, unique in the user's mailbox. |
True |
|
body |
|
|
True |
Returns:
Summary: Delete a task
Description: This operation will delete an existing task.
Syntax:
OutlookTasks.DeleteTask_V1 (string task_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
task_id |
string (Task ID) |
The programatic task ID, unique in the user's mailbox. |
True |
Returns:
Summary: Complete a task
Description: Completes a task and sets the `CompletedDateTime` property to the current date, and `Status` property to `Completed`.
Syntax:
OutlookTasks.CompleteTask_V2 (string task_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
task_id |
string (Task ID) |
The programatic task ID, unique in the user's mailbox. |
True |
Returns:
Summary: Get all completed tasks
Description: Get a list of all of my completed tasks.
Syntax:
OutlookTasks.Internal_GetAllCompletedTasks ()
Returns:
Type:array of (Task)
Summary: Get all incomplete tasks
Description: Get a list of all of my incomplete tasks.
Syntax:
OutlookTasks.Internal_GetAllIncompleteTasks ()
Returns:
Type:array of (Task)
Summary: List all task folders
Description: Returns a list of all the task folders in your mailbox.
Syntax:
OutlookTasks.GetAllTaskFolders ()
Returns:
Type:array of (TaskFolder)
Summary: Create a task folder
Description: This operation creates a new folder. Optionally, you may choose to put the new folder in an existing task group.
Syntax:
OutlookTasks.CreateTaskFolder ([Optional]string groupId, TaskFolder body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
groupId |
string (Task group) |
Group id for your task group. |
False |
|
body |
|
An Outlook task folder. |
True |
Returns:
Type:TaskFolder
Description: An Outlook task folder.
Summary: List all task groups
Description: Returns a list of all the task groups in your mailbox.
Syntax:
OutlookTasks.GetTaskGroups ()
Returns:
Type:array of (TaskGroup)
Summary: Create a task group
Description: This operation is used to create a new task group in your mailbox.
Syntax:
OutlookTasks.CreateTaskGroup (TaskGroup body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
An Outlook task group. |
True |
Returns:
Type:TaskGroup
Description: An Outlook task group.
Summary: List task folders in group
Description: Returns a list of task folders in the given task group.
Syntax:
OutlookTasks.GetTaskFolders (string groupId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
groupId |
string (Task group) |
Pick a task group. |
True |
Returns:
Type:array of (TaskFolder)
Summary: List tasks in folder
Description: This operation returns a list of tasks in a given folder.
Syntax:
OutlookTasks.GetTasksByFolder (string groupId, string folderId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
groupId |
string (Task group) |
Pick a task group. |
True |
|
folderId |
string (Task folder) |
Pick a task folder. |
True |
Returns:
Type:array of (Task)
Summary: List all tasks
Description: This operation returns a list of all your tasks.
Syntax:
OutlookTasks.GetAllTasks ()
Returns:
Type:array of (Task)
Summary: Create a task
Description: This operation is used to create a task in the specified task folder (defaults to My Tasks).
Syntax:
OutlookTasks.CreateTask ([Optional]string folderId, CreateTaskBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
folderId |
string (Folder Id) |
Pick a task folder. |
False |
|
body |
|
An Outlook task. |
True |
Returns:
Type:Task
Description: An Outlook task object.
Summary: Create a task (V2)
Description: This operation is used to create a task in the specified task folder (defaults to My Tasks).
Syntax:
OutlookTasks.CreateTaskV2 ([Optional]string folderId, CreateTaskHTMLBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
folderId |
string (Folder Id) |
Pick a task folder. |
False |
|
body |
|
An Outlook task. |
True |
Returns:
Type:TaskHTML
Description: An Outlook task object.
Summary: Complete a task
Description: This operation marks the given task as complete.
Syntax:
OutlookTasks.CompleteTask (string taskId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
taskId |
string (Task) |
Unique id of the task to complete. |
True |
Returns:
Type:Task
Description: An Outlook task object.
Summary: Get a task
Description: This operation is used to retrieve the details of a task by its id.
Syntax:
OutlookTasks.GetTask (string taskId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
taskId |
string (Task Id) |
Unique id of the task. |
True |
Returns:
Type:Task
Description: An Outlook task object.
Summary: Mark a task as incomplete
Description: This operation is used to mark the given task as incomplete.
Syntax:
OutlookTasks.IncompleteTask (string taskId, IncompleteTaskBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
taskId |
string (Task) |
Unique id of the task. |
True |
|
body |
|
|
True |
Returns:
Type:Task
Description: An Outlook task object.
Summary: When a task is added
Description: This operation triggers when a new task is created.
Syntax:
OutlookTasks.Trigger_OnNewTask ([Optional]string folderId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
folderId |
string (Folder) |
Pick the folder to track for new tasks. |
False |
Returns:
Type:array of (Task)
Summary: When a task is completed
Description: This operation triggers when a task is marked as complete.
Syntax:
OutlookTasks.Trigger_OnCompletedTask (string taskId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
taskId |
string (Task) |
Unique id of the task to track. |
True |
Returns:
Type:Task
Description: An Outlook task object.
Summary:
Description:
Properties:
Name |
Type |
Summary |
value |
array of (TaskOS)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Status |
string
|
Indicates state or progress of the task. Values: [NotStarted, InProgress, Completed, WaitingOnOthers, Deferred] |
Subject |
string
|
Brief description or title of the task. |
Body |
|
Task body that typically contains information about the task. |
Categories |
array of (string)
|
Collection of category names associated with the task. |
Importance |
string
|
The importance of this task. Values: [Low, Normal, High] |
Sensitivity |
string
|
Indicates the level of privacy for this task. Values: [Normal, Personal, Private, Confidential] |
StartDateTime |
|
The date and time when the task is to begin. |
DueDateTime |
|
The date the task is to be finished. |
CompletedDateTime |
request-TaskOS-CompletedDateTime
|
The date and time when the task was finished. |
IsReminderOn |
boolean
|
True if an alert is set to remind the user of the task. |
ReminderDateTime |
request-TaskOS-ReminderDateTime
|
The date and time for a reminder alert of the task to occur. This only applies when 'Is reminder on' is set to true. |
Summary:
Description: An Outlook task.
Properties:
Name |
Type |
Summary |
DueDateTime |
|
Date in the UTC time zone when the task is to be finished. |
ReminderDateTime |
|
Date-time in UTC time zone for a reminder alert of the task to occur. |
StartDateTime |
|
Date in the UTC time zone when the task is to begin. |
Importance |
string
|
Low, normal or high. Values: [Low, Normal, High] |
Subject |
string
|
Brief description or title of the task. |
Status |
string
|
Indicates state or progress of the task - not started, in progress, completed, waiting on others or deferred. Values: [NotStarted, InProgress, Completed, WaitingOnOthers, Deferred] |
Sensitivity |
string
|
Indicates the level of privacy for the event. Values: [Normal, Personal, Private, Confidential] |
Body |
|
Task body that typically contains information about the task. |
Categories |
array of (string)
|
Collection of category names associated with the task. |
IsReminderOn |
boolean Is Reminder On |
True if an alert is set to remind the user of the task. |
Summary:
Description: Date in the UTC time zone when the task is to be finished.
Properties:
Name |
Type |
Summary |
DateTime |
string(date-time) Due Date |
YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ (note the time portion will be ignored). |
TimeZone |
string Due Time Zone |
Time zone of the due date. |
Summary:
Description: Date-time in UTC time zone for a reminder alert of the task to occur.
Properties:
Name |
Type |
Summary |
DateTime |
string(date-time) Reminder Date-Time |
YYYY-MM-DDThh:mm:ssZ (UTC format). |
TimeZone |
string Reminder Time Zone |
Time zone of the reminder date. |
Summary:
Description: Date in the UTC time zone when the task is to begin.
Properties:
Name |
Type |
Summary |
DateTime |
string(date-time) Start Date |
YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ (note the time portion will be ignored). |
TimeZone |
string Start Time Zone |
Time zone of the start date. |
Summary:
Description: Task body that typically contains information about the task.
Properties:
Name |
Type |
Summary |
ContentType |
string
|
The content type of the body. Text or HTML. Values: [Text, HTML] |
Content |
string
|
The text or HTML content. |
Summary:
Description: An Outlook task.
Properties:
Name |
Type |
Summary |
DueDateTime |
|
Date in the UTC time zone when the task is to be finished. |
ReminderDateTime |
|
Date-time in UTC time zone for a reminder alert of the task to occur. |
StartDateTime |
|
Date in the UTC time zone when the task is to begin. |
Importance |
string
|
Low, normal or high. Values: [Low, Normal, High] |
Subject |
string
|
Brief description or title of the task. |
Status |
string
|
Indicates state or progress of the task - not started, in progress, completed, waiting on others or deferred. Values: [NotStarted, InProgress, Completed, WaitingOnOthers, Deferred] |
Sensitivity |
string
|
Indicates the level of privacy for the event. Values: [Normal, Personal, Private, Confidential] |
Body |
|
Task body that typically contains information about the task. |
Categories |
array of (string)
|
Collection of category names associated with the task. |
IsReminderOn |
boolean Is Reminder On |
True if an alert is set to remind the user of the task. |
Summary:
Description: Date in the UTC time zone when the task is to be finished.
Properties:
Name |
Type |
Summary |
DateTime |
string(date-time) Due Date |
YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ (note the time portion will be ignored). |
TimeZone |
string Due Time Zone |
Time zone of the due date. |
Summary:
Description: Date-time in UTC time zone for a reminder alert of the task to occur.
Properties:
Name |
Type |
Summary |
DateTime |
string(date-time) Reminder Date-Time |
YYYY-MM-DDThh:mm:ssZ (UTC format). |
TimeZone |
string Reminder Time Zone |
Time zone of the reminder date. |
Summary:
Description: Date in the UTC time zone when the task is to begin.
Properties:
Name |
Type |
Summary |
DateTime |
string(date-time) Start Date |
YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ (note the time portion will be ignored). |
TimeZone |
string Start Time Zone |
Time zone of the start date. |
Summary:
Description: Task body that typically contains information about the task.
Properties:
Name |
Type |
Summary |
ContentType |
string
|
The content type of the body. Text or HTML. |
Content |
string(html)
|
The content. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Status |
string
|
|
CompletedDateTime |
|
Date-time in the UTC time zone when the task was finished. |
Summary:
Description: Date-time in the UTC time zone when the task was finished.
Properties:
Name |
Type |
Summary |
DateTime |
string(date-time) Completed Date-Time |
YYYY-MM-DDThh:mm:ssZ (UTC format). |
TimeZone |
string Completed Time Zone |
Time zone of the completion date. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Status |
string
|
Indicates state or progress of the task. Values: [NotStarted, InProgress, Completed, WaitingOnOthers, Deferred] |
Subject |
string
|
Brief description or title of the task. |
Body |
|
Task body that typically contains information about the task. |
Categories |
array of (string)
|
Collection of category names associated with the task. |
Importance |
string
|
The importance of this task. Values: [Low, Normal, High] |
Sensitivity |
string
|
Indicates the level of privacy for this task. Values: [Normal, Personal, Private, Confidential] |
StartDateTime |
|
The date and time when the task is to begin. |
DueDateTime |
|
The date the task is to be finished. |
CompletedDateTime |
request-TaskOS-CompletedDateTime
|
The date and time when the task was finished. |
IsReminderOn |
boolean
|
True if an alert is set to remind the user of the task. |
ReminderDateTime |
request-TaskOS-ReminderDateTime
|
The date and time for a reminder alert of the task to occur. This only applies when 'Is reminder on' is set to true. |
Summary:
Description: Task body that typically contains information about the task.
Properties:
Name |
Type |
Summary |
ContentType |
string
|
Default to HTML when editing to mimic the format. Values: [Text, HTML] |
Content |
string(html)
|
The HTML content for the body of the task. |
Summary:
Description: The date and time when the task was finished.
Properties:
Name |
Type |
Summary |
DateTime |
string(date)
|
Format: YYYY-MM-DD. |
TimeZone |
string
|
Time zone to use for the `DateTime` field. Values: [UTC, Dateline Standard Time, Samoa Standard Time, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time, Mountain Standard Time, Mountain Standard Time (Mexico), US Mountain Standard Time, Canada Central Standard Time, Central Standard Time (Mexico), Central Standard Time, Central America Standard Time, US Eastern Standard Time, Eastern Standard Time, SA Pacific Standard Time, Pacific SA Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Atlantic Standard Time, Newfoundland Standard Time, Greenland Standard Time, SA Eastern Standard Time, E. South America Standard Time, Mid-Atlantic Standard Time, Cape Verde Standard Time, Azores Standard Time, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, GTB Standard Time, Egypt Standard Time, South Africa Standard Time, FLE Standard Time, Israel Standard Time, E. Europe Standard Time, Namibia Standard Time, Arabic Standard Time, Arab Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, Ekaterinburg Standard Time, West Asia Standard Time, India Standard Time, Nepal Standard Time, N. Central Asia Standard Time, Central Asia Standard Time, Sri Lanka Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Vladivostok Standard Time, Central Pacific Standard Time, New Zealand Standard Time, Fiji Standard Time, Tonga Standard Time] |
Summary:
Description: The date the task is to be finished.
Properties:
Name |
Type |
Summary |
DateTime |
string(date)
|
Format: YYYY-MM-DD. |
TimeZone |
string
|
Time zone to use for the `DateTime` field. Values: [UTC, Dateline Standard Time, Samoa Standard Time, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time, Mountain Standard Time, Mountain Standard Time (Mexico), US Mountain Standard Time, Canada Central Standard Time, Central Standard Time (Mexico), Central Standard Time, Central America Standard Time, US Eastern Standard Time, Eastern Standard Time, SA Pacific Standard Time, Pacific SA Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Atlantic Standard Time, Newfoundland Standard Time, Greenland Standard Time, SA Eastern Standard Time, E. South America Standard Time, Mid-Atlantic Standard Time, Cape Verde Standard Time, Azores Standard Time, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, GTB Standard Time, Egypt Standard Time, South Africa Standard Time, FLE Standard Time, Israel Standard Time, E. Europe Standard Time, Namibia Standard Time, Arabic Standard Time, Arab Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, Ekaterinburg Standard Time, West Asia Standard Time, India Standard Time, Nepal Standard Time, N. Central Asia Standard Time, Central Asia Standard Time, Sri Lanka Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Vladivostok Standard Time, Central Pacific Standard Time, New Zealand Standard Time, Fiji Standard Time, Tonga Standard Time] |
Summary:
Description: The date and time for a reminder alert of the task to occur. This only applies when 'Is reminder on' is set to true.
Properties:
Name |
Type |
Summary |
DateTime |
string
|
Format: YYYY-MM-DDThh:mm:ss. |
TimeZone |
string
|
Time zone to use for the `DateTime` field. Values: [UTC, Dateline Standard Time, Samoa Standard Time, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time, Mountain Standard Time, Mountain Standard Time (Mexico), US Mountain Standard Time, Canada Central Standard Time, Central Standard Time (Mexico), Central Standard Time, Central America Standard Time, US Eastern Standard Time, Eastern Standard Time, SA Pacific Standard Time, Pacific SA Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Atlantic Standard Time, Newfoundland Standard Time, Greenland Standard Time, SA Eastern Standard Time, E. South America Standard Time, Mid-Atlantic Standard Time, Cape Verde Standard Time, Azores Standard Time, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, GTB Standard Time, Egypt Standard Time, South Africa Standard Time, FLE Standard Time, Israel Standard Time, E. Europe Standard Time, Namibia Standard Time, Arabic Standard Time, Arab Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, Ekaterinburg Standard Time, West Asia Standard Time, India Standard Time, Nepal Standard Time, N. Central Asia Standard Time, Central Asia Standard Time, Sri Lanka Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Vladivostok Standard Time, Central Pacific Standard Time, New Zealand Standard Time, Fiji Standard Time, Tonga Standard Time] |
Summary:
Description: The date and time when the task is to begin.
Properties:
Name |
Type |
Summary |
DateTime |
string(date)
|
Format: YYYY-MM-DD. |
TimeZone |
string
|
Time zone to use for the `DateTime` field. Values: [UTC, Dateline Standard Time, Samoa Standard Time, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time, Mountain Standard Time, Mountain Standard Time (Mexico), US Mountain Standard Time, Canada Central Standard Time, Central Standard Time (Mexico), Central Standard Time, Central America Standard Time, US Eastern Standard Time, Eastern Standard Time, SA Pacific Standard Time, Pacific SA Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Atlantic Standard Time, Newfoundland Standard Time, Greenland Standard Time, SA Eastern Standard Time, E. South America Standard Time, Mid-Atlantic Standard Time, Cape Verde Standard Time, Azores Standard Time, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, GTB Standard Time, Egypt Standard Time, South Africa Standard Time, FLE Standard Time, Israel Standard Time, E. Europe Standard Time, Namibia Standard Time, Arabic Standard Time, Arab Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, Ekaterinburg Standard Time, West Asia Standard Time, India Standard Time, Nepal Standard Time, N. Central Asia Standard Time, Central Asia Standard Time, Sri Lanka Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Vladivostok Standard Time, Central Pacific Standard Time, New Zealand Standard Time, Fiji Standard Time, Tonga Standard Time] |
Summary:
Description: An Outlook task object.
Properties:
Name |
Type |
Summary |
@odata.context |
string
|
|
@odata.id |
string
|
|
@odata.etag |
string
|
|
Id |
string
|
Unique identifier of the task. |
CreatedDateTime |
string(date-time)
|
YYYY-MM-DDThh:mm:ssZ (UTC format). |
LastModifiedDateTime |
string(date-time)
|
YYYY-MM-DDThh:mm:ssZ (UTC format). |
ChangeKey |
string
|
|
Categories |
array of (string)
|
Collection of category names associated with the task. |
AssignedTo |
string
|
Name of the person who has been assigned the task. |
Body |
|
Task body that typically contains information about the task. |
CompletedDateTime |
|
Date-time in the UTC time zone when the task was finished. |
DueDateTime |
|
Date in the UTC time zone when the task is to be finished. |
Importance |
string
|
Low, normal or high. Values: [Low, Normal, High] |
IsReminderOn |
boolean
|
True if an alert is set to remind the user of the task. |
Owner |
string
|
Name of the person who created the task. |
ParentFolderId |
string
|
|
ReminderDateTime |
|
Date-time in the UTC time zone for a reminder alert of the task to occur. |
StartDateTime |
|
Date in the UTC time zone when the task is to begin. |
Status |
string
|
Indicates state or progress of the task - not started, in progress, completed, waiting on others or deferred. Values: [NotStarted, InProgress, Completed, WaitingOnOthers, Deferred] |
Subject |
string
|
Brief description or title of the task. |
Summary:
Description: Task body that typically contains information about the task.
Properties:
Name |
Type |
Summary |
ContentType |
string
|
The content type of the body. Text or HTML. Values: [Text, HTML] |
Content |
string
|
The text or HTML content. |
Summary:
Description: Date-time in the UTC time zone when the task was finished.
Properties:
Name |
Type |
Summary |
DateTime |
string(date-time)
|
YYYY-MM-DDThh:mm:ssZ (UTC format). |
Summary:
Description: Date in the UTC time zone when the task is to be finished.
Properties:
Name |
Type |
Summary |
DateTime |
string(date-time)
|
YYYY-MM-DDThh:mm:ssZ (UTC format). |
Summary:
Description: Date-time in the UTC time zone for a reminder alert of the task to occur.
Properties:
Name |
Type |
Summary |
DateTime |
string(date-time)
|
YYYY-MM-DDThh:mm:ssZ (UTC format). |
Summary:
Description: Date in the UTC time zone when the task is to begin.
Properties:
Name |
Type |
Summary |
DateTime |
string(date-time)
|
YYYY-MM-DDThh:mm:ssZ (UTC format). |
Summary:
Description: An Outlook task folder.
Properties:
Name |
Type |
Summary |
@odata.id |
string
|
|
Id |
string
|
Unique identifier of the task folder. |
Name |
string
|
Name of the task folder. |
ChangeKey |
string
|
|
IsDefaultFolder |
boolean Is Default |
True if this is the default task folder. |
ParentGroupKey |
string Parent Group Key |
Unique GUID identifier for the task folder's parent group. |
Summary:
Description: An Outlook task group.
Properties:
Name |
Type |
Summary |
@odata.id |
string
|
|
Id |
string
|
Unique identifier of the task group. |
Name |
string
|
Name of the task group. |
ChangeKey |
string
|
|
IsDefaultGroup |
boolean Is Default |
True if default task group. |
GroupKey |
string
|
Unique GUID identifier for the task group. |
Summary:
Description: An Outlook task object.
Properties:
Name |
Type |
Summary |
@odata.context |
string
|
|
@odata.id |
string
|
|
@odata.etag |
string
|
|
Id |
string
|
Unique identifier of the task. |
CreatedDateTime |
string(date-time)
|
YYYY-MM-DDThh:mm:ssZ (UTC format). |
LastModifiedDateTime |
string(date-time)
|
YYYY-MM-DDThh:mm:ssZ (UTC format). |
ChangeKey |
string
|
|
Categories |
array of (string)
|
Collection of category names associated with the task. |
AssignedTo |
string
|
Name of the person who has been assigned the task. |
Body |
|
Task body that typically contains information about the task. |
CompletedDateTime |
|
Date-time in the UTC time zone when the task was finished. |
DueDateTime |
|
Date in the UTC time zone when the task is to be finished. |
Importance |
string
|
Low, normal or high. Values: [Low, Normal, High] |
IsReminderOn |
boolean
|
True if an alert is set to remind the user of the task. |
Owner |
string
|
Name of the person who created the task. |
ParentFolderId |
string
|
|
ReminderDateTime |
|
Date-time in the UTC time zone for a reminder alert of the task to occur. |
StartDateTime |
|
Date in the UTC time zone when the task is to begin. |
Status |
string
|
Indicates state or progress of the task - not started, in progress, completed, waiting on others or deferred. Values: [NotStarted, InProgress, Completed, WaitingOnOthers, Deferred] |
Subject |
string
|
Brief description or title of the task. |
Summary:
Description: Task body that typically contains information about the task.
Properties:
Name |
Type |
Summary |
Content |
string(html)
|
The content. |
Summary:
Description: Date-time in the UTC time zone when the task was finished.
Properties:
Name |
Type |
Summary |
DateTime |
string(date-time)
|
YYYY-MM-DDThh:mm:ssZ (UTC format). |
Summary:
Description: Date in the UTC time zone when the task is to be finished.
Properties:
Name |
Type |
Summary |
DateTime |
string(date-time)
|
YYYY-MM-DDThh:mm:ssZ (UTC format). |
Summary:
Description: Date-time in the UTC time zone for a reminder alert of the task to occur.
Properties:
Name |
Type |
Summary |
DateTime |
string(date-time)
|
YYYY-MM-DDThh:mm:ssZ (UTC format). |
Summary:
Description: Date in the UTC time zone when the task is to begin.
Properties:
Name |
Type |
Summary |
DateTime |
string(date-time)
|
YYYY-MM-DDThh:mm:ssZ (UTC format). |
Summary:
Description: An Outlook task object.
Properties:
Name |
Type |
Summary |
@odata.id |
string
|
|
@odata.etag |
string
|
|
Id |
string
|
Unique identifier of the task. |
ChangeKey |
string
|
|
ParentFolderId |
string
|
The unique id of the folder in which this task is located. |
AssignedTo |
string
|
Name of the person who has been assigned the task. |
Owner |
string
|
Name of the person who created the task. |
CreatedDateTime |
string(date-time)
|
The date and time when the task was created. |
LastModifiedDateTime |
string(date-time)
|
The date and time when this task was last modified. |
HasAttachments |
boolean
|
True if this task has attachments. |
Status |
string
|
Indicates state or progress of the task. Values: [NotStarted, InProgress, Completed, WaitingOnOthers, Deferred] |
Subject |
string
|
Brief description or title of the task. |
Body |
|
Task body that typically contains information about the task. |
Categories |
array of (string)
|
Collection of category names associated with the task. |
Importance |
string
|
The importance of this task. Values: [Low, Normal, High] |
Sensitivity |
string
|
Indicates the level of privacy for this task. Values: [Normal, Personal, Private, Confidential] |
StartDateTime |
|
The date and time when the task is to begin. |
DueDateTime |
|
The date the task is to be finished. |
CompletedDateTime |
|
The date and time when the task was finished. |
IsReminderOn |
boolean
|
True if an alert is set to remind the user of the task. |
ReminderDateTime |
|
The date and time for a reminder alert of the task to occur. This only applies when 'Is reminder on' is set to true. |
Summary:
Description: Task body that typically contains information about the task.
Properties:
Name |
Type |
Summary |
ContentType |
string
|
The format of the `Content` field. Usually it is `HTML`, but may be `Text` when no body was yet specified for this task. Values: [Text, HTML] |
Content |
string
|
The text or HTML content. |
Summary:
Description: The date and time when the task is to begin.
Properties:
Name |
Type |
Summary |
DateTime |
string
|
Format: YYYY-MM-DD. |
TimeZone |
string
|
The time zone in which the `DateTime` field is expressed. |
Summary:
Description: The date the task is to be finished.
Properties:
Name |
Type |
Summary |
DateTime |
string
|
Format: YYYY-MM-DD. |
TimeZone |
string
|
The time zone in which the `DateTime` field is expressed. |
Summary:
Description: The date and time when the task was finished.
Properties:
Name |
Type |
Summary |
DateTime |
string
|
UTC Format: YYYY-MM-DDThh:mm:ssZ. |
TimeZone |
string
|
The time zone in which the `DateTime` field is expressed. |
Summary:
Description: The date and time for a reminder alert of the task to occur. This only applies when 'Is reminder on' is set to true.
Properties:
Name |
Type |
Summary |
DateTime |
string
|
UTC Format: YYYY-MM-DDThh:mm:ssZ. |
TimeZone |
string
|
The time zone in which the `DateTime` field is expressed. |