Connectors Reference

Microsoft To-Do (Business)

Microsoft To-Do is an intelligent task management app that makes it easy to plan and manage your day. Connect to Microsoft To-Do to manage your tasks from various services. You can perform actions such as creating tasks.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

GetAllTodoLists ()

List all to-do lists

CreateToDo ([Optional]string folderId, CreateToDoBody body)

Add a to-do

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

CreateToDoBody

 

ToDo

 

TodoList

 

 

Actions:

GetAllTodoLists

Summary: List all to-do lists

Description: Returns a list of all the to-do lists.

 

Syntax:

MicrosoftTo-Do(Business).GetAllTodoLists ()

 

Returns:

          Type:array of (TodoList)

 

CreateToDo

Summary: Add a to-do

Description: This operation is used to create a to-do in the specified to-do list (defaults to To-Do).

 

Syntax:

MicrosoftTo-Do(Business).CreateToDo ([Optional]string folderId, CreateToDoBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

False

GetAllTodoLists

body

CreateToDoBody

 

A Microsoft To-Do.

True

 

Returns:

          Type:ToDo

          Description: A Microsoft To-Do object.

 


 

CreateToDoBody

Summary:

Description: A Microsoft To-Do.

 

          Properties:

Name

Type

Summary

DueDateTime

DueDateTime

 

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

ReminderDateTime

ReminderDateTime

 

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

StartDateTime

StartDateTime

 

Date in the UTC time zone when the to-do is to begin.

Importance

string

 

Low, normal or high.  Values: [Low, Normal, High]

Subject

string

 

Brief description or title of the to-do.

Status

string

 

Indicates state or progress of the to-do - 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

 

To-do body that typically contains information about the to-do.

Categories

array of (string)

 

Collection of category names associated with the to-do.

IsReminderOn

boolean

Is Reminder On

True if an alert is set to remind the user of the to-do.

 

DueDateTime

Summary:

Description: Date in the UTC time zone when the to-do 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 to-do 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 to-do 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: To-do body that typically contains information about the to-do.

 

          Properties:

Name

Type

Summary

ContentType

string

 

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

Content

string

 

The text or HTML content.

 


 

ToDo

Summary:

Description: A Microsoft To-Do object.

 

          Properties:

Name

Type

Summary

@odata.context

string

 

 

@odata.id

string

 

 

@odata.etag

string

 

 

id

string

 

Unique identifier of the to-do.

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 to-do.

assignedTo

string

 

Name of the person who has been assigned the to-do.

body

Body

 

To-do body that typically contains information about the to-do.

completedDateTime

CompletedDateTime

 

Date-time in the UTC time zone when the to-do was finished.

dueDateTime

DueDateTime

 

Date in the UTC time zone when the to-do 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 to-do.

owner

string

 

Name of the person who created the to-do.

parentFolderId

string

 

 

reminderDateTime

ReminderDateTime

 

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

startDateTime

StartDateTime

 

Date in the UTC time zone when the to-do is to begin.

status

string

 

Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred.  Values: [NotStarted, InProgress, Completed, WaitingOnOthers, Deferred]

subject

string

 

Brief description or title of the to-do.

 

Body

Summary:

Description: To-do body that typically contains information about the to-do.

 

          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 to-do 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 to-do 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 to-do 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 to-do is to begin.

 

          Properties:

Name

Type

Summary

dateTime

string(date-time)

 

YYYY-MM-DDThh:mm:ssZ (UTC format)

 


 

TodoList

Summary:

Description: An Microsoft To-Do list.

 

          Properties:

Name

Type

Summary

@odata.id

string

 

 

id

string

 

Unique identifier of the to-do list.

changeKey

string

 

 

name

string

 

Name of the to-do list.

isDefaultFolder

boolean

Is Default

True if this is the default to-do list.

parentGroupKey

string