Connectors Reference

Outlook Tasks

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: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

Internal_GetAllCompletedTasks ()

Get all completed tasks

Internal_GetAllIncompleteTasks ()

Get all incomplete tasks

GetAllTaskFolders ()

List all task folders

CreateTaskFolder ([Optional]string groupId, CreateTaskFolderBody body)

Create a task folder

GetTaskGroups ()

List all task groups

CreateTaskGroup (CreateTaskGroupBody body)

Create a task group

GetTasksByFolder (string groupId, string folderId)

List all tasks in folder

GetAllTasks ()

List all tasks

CreateTask ([Optional]string folderId, CreateTaskBody body)

Create a task

GetTaskFolders (string groupId)

Get task folders in group

CompleteTask (string taskId)

Complete a task

GetTask (string taskId)

Get task

IncompleteTask (string taskId, IncompleteTaskBody body)

Mark a task as incomplete

 

Triggers:

Name

Summary

Trigger_OnNewTask ([Optional]string folderId)

When a task is added

Trigger_OnCompletedTask (string taskId)

When a task is completed

 

Objects:

Name

Summary

CreateTaskBody

 

CreateTaskFolderBody

 

CreateTaskGroupBody

 

IncompleteTaskBody

 

Task

 

TaskFolder

 

TaskGroup

 

 

Actions:

Internal_GetAllCompletedTasks

Summary: Get all completed tasks

Description: Get a list of all of my completed tasks.

 

Syntax:

OutlookTasks.Internal_GetAllCompletedTasks ()

 

Returns:

          Type:array of (Task)

 

Internal_GetAllIncompleteTasks

Summary: Get all incomplete tasks

Description: Get a list of all of my incomplete tasks.

 

Syntax:

OutlookTasks.Internal_GetAllIncompleteTasks ()

 

Returns:

          Type:array of (Task)

 

GetAllTaskFolders

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)

 

CreateTaskFolder

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, CreateTaskFolderBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Task group)

Group id for your task group.

False

GetTaskGroups

body

CreateTaskFolderBody

 

An Outlook Task Folder.

True

 

Returns:

          Type:TaskFolder

          Description: An Outlook task folder.

 

GetTaskGroups

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)

 

CreateTaskGroup

Summary: Create a task group

Description: This operation is used to create a new task group in your mailbox.

 

Syntax:

OutlookTasks.CreateTaskGroup (CreateTaskGroupBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateTaskGroupBody

 

 

True

 

Returns:

          Type:TaskGroup

 

GetTasksByFolder

Summary: List all tasks in folder

Description: This operation returns a list of all 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

GetTaskGroups

folderId

string

(Task folder)

Pick a task folder.

True

GetTaskFolders

 

Returns:

          Type:array of (Task)

 

GetAllTasks

Summary: List all tasks

Description: This operation returns a list of all your tasks.

 

Syntax:

OutlookTasks.GetAllTasks ()

 

Returns:

          Type:array of (Task)

 

CreateTask

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)

Folder

False

GetAllTaskFolders

body

CreateTaskBody

 

An Outlook task.

True

 

Returns:

          Type:Task

          Description: An Outlook task object.

 

GetTaskFolders

Summary: Get 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)

Task group

True

GetTaskGroups

 

Returns:

          Type:array of (TaskFolder)

 

CompleteTask

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

Internal_GetAllIncompleteTasks

 

Returns:

          Type:Task

          Description: An Outlook task object.

 

GetTask

Summary: Get 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.

 

IncompleteTask

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

Internal_GetAllCompletedTasks

body

IncompleteTaskBody

 

 

True

 

Returns:

          Type:Task

          Description: An Outlook task object.

 

Triggers:

Trigger Trigger_OnNewTask

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

GetAllTaskFolders

 

Returns:

          Type:array of (Task)

 

Trigger Trigger_OnCompletedTask

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

Internal_GetAllIncompleteTasks

 

Returns:

          Type:Task

          Description: An Outlook task object.

 


 

CreateTaskBody

Summary:

Description: An Outlook task.

 

          Properties:

Name

Type

Summary

DueDateTime

DueDateTime

 

Date in the UTC time zone when the task is to be finished.

ReminderDateTime

ReminderDateTime

 

Date-time in UTC time zone for a reminder alert of the task to occur.

StartDateTime

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: [Nomral, Personal, Private, Confidential]

Body

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.

 

DueDateTime

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.

 

ReminderDateTime

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.

 

StartDateTime

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.

 

Body

Summary:

Description: Task body that typically contains information about the task.

 

          Properties:

Name

Type

Summary

ContentType

string

 

Text=0, HTML=1  Values: [Text, HTML]

Content

string

 

The text or HTML content.

 


 

CreateTaskFolderBody

Summary:

Description: An Outlook Task Folder.

 

          Properties:

Name

Type

Summary

Name

string

 

Name of the task folder


 

CreateTaskGroupBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

Name

string

Name

Ttile of the task group.


 

IncompleteTaskBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

Status

string

 

 

CompletedDateTime

CompletedDateTime

 

Date-time in the UTC time zone when the task was finished.

 

CompletedDateTime

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.

 


 

Task

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

Body

 

Task body that typically contains information about the task.

CompletedDateTime

CompletedDateTime

 

Date-time in the UTC time zone when the task was finished.

DueDateTime

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

ReminderDateTime

 

Date-time in the UTC time zone for a reminder alert of the task to occur.

StartDateTime

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.

 

Body

Summary:

Description: Task body that typically contains information about the task.

 

          Properties:

Name

Type

Summary

ContentType

string

 

Text=0, HTML=1  Values: [Text, HTML]

Content

string

 

The text or HTML content.

 

CompletedDateTime

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)

 

DueDateTime

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)

 

ReminderDateTime

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)

 

StartDateTime

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)

 


 

TaskFolder

Summary:

Description: An Outlook task folder.

 

          Properties:

Name

Type

Summary

@odata.id

string

 

 

Id

string

 

Unique identifier of the task folder.

ChangeKey

string

 

 

Name

string

 

Name of the task folder.

IsDefaultFolder

boolean

Is Default

True if this is the default task folder.

ParentGroupKey

string

 

 


 

TaskGroup

Summary:

Description:

 

          Properties:

Name

Type

Summary

@odata.id

string

 

 

Id

string

 

 

ChangeKey

string

 

 

IsDefaultGroup

boolean

Is Default

True if default task group.

Name

string

 

Name of the task group.

GroupKey

string