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

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

GetAllTodoListsV2 ()

List all to-do lists (V2)

CreateToDoListV2 (CreateToDoList_V2 body)

Create a to-do list (V2)

GetToDoListV2 (string folderId)

Get a to-do list (V2)

UpdateToDoList (string folderId, CreateToDoList_V2 body)

Update a to-do list

DeleteToDoList (string folderId)

Delete a to-do list

ListToDosByFolderV2 (string folderId, [Optional]integer $top)

List to-do's by folder (V2)

CreateToDoV3 (string folderId, CreateToDo_V2 body)

Add a to-do (V3)

GetToDoV3 (string folderId, string id)

Get a to-do (V3)

UpdateToDoV2 (string folderId, string id, UpdateToDo_V2 body)

Update to-do (V2)

DeleteToDoV2 (string folderId, string id)

Delete to-do (V2)

GetAllTodoLists ()

List all to-do lists

CreateToDoList (CreateToDoListBody body)

Create a to-do list

GetToDoList (string id)

Get a to-do list

ListToDosByFolder (string folderId, [Optional]integer $top)

List to-do's by folder

ListAllToDos ([Optional]integer $top)

List all to-do's

CreateToDo ([Optional]string folderId, CreateToDoBody body)

Add a to-do

CreateToDoV2 ([Optional]string folderId, CreateToDoHtmlBody body)

Add a to-do (V2)

GetToDo (string id)

Get a to-do

UpdateToDo (string folderId, string id, UpdateToDoBody body)

Update to-do

DeleteToDo (string folderId, string id)

Delete to-do

GetToDoV2 (string folderId, string id)

Get a to-do (V2)

 

Triggers:

Name

Summary

OnNewToDo ()

When a new to-do is created

OnNewToDoInFolder (string folderId)

When a new to-do in a specific folder is created

OnUpdateToDo ()

When a to-do is updated

OnUpdateToDoInFolder (string folderId)

When a to-do in a specific folder is updated

OnNewToDoInFolderV2 (string folderId)

When a new to-do in a specific folder is created (V2)

OnUpdateToDoInFolderV2 (string folderId)

When a to-do in a specific folder is updated (V2)

 

Objects:

Name

Summary

CreateToDoBody

 

CreateToDoHtmlBody

 

CreateToDoListBody

 

CreateToDoList_V2

 

CreateToDo_V2

 

ToDo

 

ToDoHtml

 

TodoList

 

TodoList_V2

 

ToDo_V2

 

UpdateToDoBody

 

UpdateToDo_V2

 

 

Actions:

GetAllTodoListsV2

Summary: List all to-do lists (V2)

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

 

Syntax:

MicrosoftTo-Do(Business).GetAllTodoListsV2 ()

 

Returns:

          Type:array of (TodoList_V2)

 

CreateToDoListV2

Summary: Create a to-do list (V2)

Description: This operation is used to create a new to-do list.

 

Syntax:

MicrosoftTo-Do(Business).CreateToDoListV2 (CreateToDoList_V2 body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateToDoList_V2

 

A Microsoft To-Do list.

True

 

Returns:

          Type:TodoList_V2

          Description: An Microsoft To-Do list.

 

GetToDoListV2

Summary: Get a to-do list (V2)

Description: This operation is used to get a specific to-do list.

 

Syntax:

MicrosoftTo-Do(Business).GetToDoListV2 (string folderId)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

True

GetAllTodoListsV2

 

Returns:

          Type:TodoList_V2

          Description: An Microsoft To-Do list.

 

UpdateToDoList

Summary: Update a to-do list

Description: This operation is used to update a specific to-do list.

 

Syntax:

MicrosoftTo-Do(Business).UpdateToDoList (string folderId, CreateToDoList_V2 body)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

True

GetAllTodoListsV2

body

CreateToDoList_V2

 

A Microsoft To-Do list.

True

 

Returns:

          Type:TodoList_V2

          Description: An Microsoft To-Do list.

 

DeleteToDoList

Summary: Delete a to-do list

Description: This operation is used to delete a specific to-do list.

 

Syntax:

MicrosoftTo-Do(Business).DeleteToDoList (string folderId)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

True

GetAllTodoListsV2

 

Returns:

 

ListToDosByFolderV2

Summary: List to-do's by folder (V2)

Description: This operation is used to retrieve all to-do's from a specific list.

 

Syntax:

MicrosoftTo-Do(Business).ListToDosByFolderV2 (string folderId, [Optional]integer $top)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

True

GetAllTodoListsV2

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = 10, maximum = 999).

False

 

Returns:

          Type:array of (ToDo_V2)

 

CreateToDoV3

Summary: Add a to-do (V3)

Description: This operation is used to create a to-do in the specified to-do list.

 

Syntax:

MicrosoftTo-Do(Business).CreateToDoV3 (string folderId, CreateToDo_V2 body)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

True

GetAllTodoListsV2

body

CreateToDo_V2

 

A Microsoft To-Do.

True

 

Returns:

          Type:ToDo_V2

          Description: A Microsoft To-Do object.

 

GetToDoV3

Summary: Get a to-do (V3)

Description: This operation is used to get the to-do with the given Id.

 

Syntax:

MicrosoftTo-Do(Business).GetToDoV3 (string folderId, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

True

GetAllTodoListsV2

id

string

(To-do task)

To-do task

True

ListToDosByFolderV2

 

Returns:

          Type:ToDo_V2

          Description: A Microsoft To-Do object.

 

UpdateToDoV2

Summary: Update to-do (V2)

Description: This operation is used to update a specific to-do.

 

Syntax:

MicrosoftTo-Do(Business).UpdateToDoV2 (string folderId, string id, UpdateToDo_V2 body)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

True

GetAllTodoListsV2

id

string

(To-do task)

To-do task

True

ListToDosByFolderV2

body

UpdateToDo_V2

 

A Microsoft To-Do.

True

 

Returns:

          Type:ToDo_V2

          Description: A Microsoft To-Do object.

 

DeleteToDoV2

Summary: Delete to-do (V2)

Description: This operation is used to delete a task.

 

Syntax:

MicrosoftTo-Do(Business).DeleteToDoV2 (string folderId, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

True

GetAllTodoListsV2

id

string

(To-do task)

To-do task

True

ListToDosByFolderV2

 

Returns:

 

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)

 

CreateToDoList

Summary: Create a to-do list

Description: This operation is used to create a new to-do list.

 

Syntax:

MicrosoftTo-Do(Business).CreateToDoList (CreateToDoListBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateToDoListBody

 

A Microsoft To-Do list.

True

 

Returns:

          Type:TodoList

          Description: An Microsoft To-Do list.

 

GetToDoList

Summary: Get a to-do list

Description: This operation is used to get a specific to-do list.

 

Syntax:

MicrosoftTo-Do(Business).GetToDoList (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(To-do List)

To-do list

True

GetAllTodoListsV2

 

Returns:

          Type:TodoList

          Description: An Microsoft To-Do list.

 

ListToDosByFolder

Summary: List to-do's by folder

Description: This operation is used to retrieve all to-do's from a specific list.

 

Syntax:

MicrosoftTo-Do(Business).ListToDosByFolder (string folderId, [Optional]integer $top)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

True

GetAllTodoListsV2

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = 10, maximum = 999).

False

 

Returns:

          Type:array of (ToDo)

 

ListAllToDos

Summary: List all to-do's

Description: This operation is used to retrieve all to-do's from all lists.

 

Syntax:

MicrosoftTo-Do(Business).ListAllToDos ([Optional]integer $top)

 

Parameters:

Name

Type

Summary

Required

Related Action

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = 10, maximum = 999).

False

 

Returns:

          Type:array of (ToDo)

 

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

GetAllTodoListsV2

body

CreateToDoBody

 

A Microsoft To-Do.

True

 

Returns:

          Type:ToDo

          Description: A Microsoft To-Do object.

 

CreateToDoV2

Summary: Add a to-do (V2)

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

 

Syntax:

MicrosoftTo-Do(Business).CreateToDoV2 ([Optional]string folderId, CreateToDoHtmlBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

False

GetAllTodoListsV2

body

CreateToDoHtmlBody

 

A Microsoft To-Do.

True

 

Returns:

          Type:ToDoHtml

          Description: A Microsoft To-Do object.

 

GetToDo

Summary: Get a to-do

Description: This operation is used to get the to-Do with the given Id.

 

Syntax:

MicrosoftTo-Do(Business).GetToDo (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(To-do Id)

To-do Id

True

 

Returns:

          Type:ToDo

          Description: A Microsoft To-Do object.

 

UpdateToDo

Summary: Update to-do

Description: This operation is used to update a specific to-do.

 

Syntax:

MicrosoftTo-Do(Business).UpdateToDo (string folderId, string id, UpdateToDoBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

True

GetAllTodoListsV2

id

string

(To-do task)

To-do task

True

ListToDosByFolder

body

UpdateToDoBody

 

A Microsoft To-Do.

True

 

Returns:

          Type:ToDo

          Description: A Microsoft To-Do object.

 

DeleteToDo

Summary: Delete to-do

Description: This operation is used to delete a task.

 

Syntax:

MicrosoftTo-Do(Business).DeleteToDo (string folderId, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

True

GetAllTodoListsV2

id

string

(To-do task)

To-do task

True

ListToDosByFolder

 

Returns:

 

GetToDoV2

Summary: Get a to-do (V2)

Description: This operation is used to get the to-do with the given Id.

 

Syntax:

MicrosoftTo-Do(Business).GetToDoV2 (string folderId, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

True

GetAllTodoListsV2

id

string

(To-do task)

To-do task

True

ListToDosByFolder

 

Returns:

          Type:ToDo

          Description: A Microsoft To-Do object.

 

Triggers:

Trigger OnNewToDo

Summary: When a new to-do is created

Description: Triggers when a new to-do is created.

 

Syntax:

MicrosoftTo-Do(Business).OnNewToDo ()

 

Returns:

          Type:array of (ToDo)

 

Trigger OnNewToDoInFolder

Summary: When a new to-do in a specific folder is created

Description: Triggers when a new to-do in a specific folder is created.

 

Syntax:

MicrosoftTo-Do(Business).OnNewToDoInFolder (string folderId)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

True

GetAllTodoListsV2

 

Returns:

          Type:array of (ToDo)

 

Trigger OnUpdateToDo

Summary: When a to-do is updated

Description: Triggers when a to-do is updated.

 

Syntax:

MicrosoftTo-Do(Business).OnUpdateToDo ()

 

Returns:

          Type:array of (ToDo)

 

Trigger OnUpdateToDoInFolder

Summary: When a to-do in a specific folder is updated

Description: Triggers when a to-do in a specific folder is updated.

 

Syntax:

MicrosoftTo-Do(Business).OnUpdateToDoInFolder (string folderId)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

True

GetAllTodoListsV2

 

Returns:

          Type:array of (ToDo)

 

Trigger OnNewToDoInFolderV2

Summary: When a new to-do in a specific folder is created (V2)

Description: Triggers when a new to-do in a specific folder is created.

 

Syntax:

MicrosoftTo-Do(Business).OnNewToDoInFolderV2 (string folderId)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

True

GetAllTodoListsV2

 

Returns:

          Type:array of (ToDo_V2)

 

Trigger OnUpdateToDoInFolderV2

Summary: When a to-do in a specific folder is updated (V2)

Description: Triggers when a to-do in a specific folder is updated.

 

Syntax:

MicrosoftTo-Do(Business).OnUpdateToDoInFolderV2 (string folderId)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderId

string

(To-do List)

To-do list

True

GetAllTodoListsV2

 

Returns:

          Type:array of (ToDo_V2)

 


 

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: [Normal, 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.

 


 

CreateToDoHtmlBody

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: [Normal, 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

 

HTML

Content

string(html)

 

The content.

 


 

CreateToDoListBody

Summary:

Description: A Microsoft To-Do list.

 

          Properties:

Name

Type

Summary

name

string

Name

List name


 

CreateToDoList_V2

Summary:

Description: A Microsoft To-Do list.

 

          Properties:

Name

Type

Summary

displayName

string

Name

List name


 

CreateToDo_V2

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 (note the time portion will be ignored).

reminderDateTime

ReminderDateTime

 

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

importance

string

 

Low, normal or high.  Values: [low, normal, high]

title

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]

body

Body

 

To-do body that typically contains information about 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 (note the time portion will be ignored).

 

          Properties:

Name

Type

Summary

dateTime

string(date-time)

Due Date

YYYY-MM-DDThh:mm:ss

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

timeZone

string

Reminder Time Zone

Time zone of the reminder date.

 

Body

Summary:

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

 

          Properties:

Name

Type

Summary

contentType

string

 

The type of the content. Possible values are text and html.

content

string(html)

 

The content of the item.

 


 

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

 

Unique identifier of the parent folder.

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)

 


 

ToDoHtml

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)

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

 

Unique identifier of the parent folder.

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

content

string(html)

 

The 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

 

 


 

TodoList_V2

Summary:

Description: An Microsoft To-Do list.

 

          Properties:

Name

Type

Summary

@odata.etag

string

 

 

id

string

 

Unique identifier of the to-do list.

displayName

string

 

Name of the to-do list.

wellknownListName

string

Well-known name

Property indicating the well-known list name if the given list is a well-known list. Possible values are: none, defaultList, flaggedEmails, unknownFutureValue.

isOwner

boolean

Is owner

True if the user is owner of the given task list.

isShared

boolean

Is shared

True if the task list is shared with other users.


 

ToDo_V2

Summary:

Description: A Microsoft To-Do object.

 

          Properties:

Name

Type

Summary

@odata.context

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)

body

Body

 

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

bodyLastModifiedDateTime

string(date-time)

 

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

completedDateTime

CompletedDateTime

 

The date in the specified time zone that the task was finished.

dueDateTime

DueDateTime

 

The date in the specified time zone that 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 to-do.

reminderDateTime

ReminderDateTime

 

The date and time for a reminder alert of the task to occur.

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]

title

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

 

The type of the content. Possible values are text and html.

content

string

 

The content of the item.

 

CompletedDateTime

Summary:

Description: The date in the specified time zone that the task was finished.

 

          Properties:

Name

Type

Summary

dateTime

string(date-time)

 

YYYY-MM-DDThh:mm:ss

 

DueDateTime

Summary:

Description: The date in the specified time zone that the task is to be finished.

 

          Properties:

Name

Type

Summary

dateTime

string(date-time)

 

YYYY-MM-DDThh:mm:ss

 

ReminderDateTime

Summary:

Description: The date and time for a reminder alert of the task to occur.

 

          Properties:

Name

Type

Summary

dateTime

string(date-time)

 

YYYY-MM-DDThh:mm:ss

 


 

UpdateToDoBody

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: [Normal, 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.

 


 

UpdateToDo_V2

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 (note the time portion will be ignored).

reminderDateTime

ReminderDateTime

 

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

importance

string

 

Low, normal or high.  Values: [low, normal, high]

title

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]

body

Body

 

To-do body that typically contains information about 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 (note the time portion will be ignored).

 

          Properties:

Name

Type

Summary

dateTime

string(date-time)

Due Date

YYYY-MM-DDThh:mm:ss

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

timeZone

string

Reminder Time Zone

Time zone of the reminder date.

 

Body

Summary:

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

 

          Properties:

Name

Type

Summary

contentType

string

 

The type of the content. Possible values are text and html.

content

string(html)

 

The content of the item.