Skip to content

task-set.mdx

Latest commit

 

History

History
183 lines (136 loc) · 7.24 KB

task-set.mdx

File metadata and controls

183 lines (136 loc) · 7.24 KB

import Global from '../../_global.mdx'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

todo task set

Update a task in a Microsoft To Do task list

Usage

m365 todo task set [options]

Options

`-i, --id <id>`
: The id of the task to update.

`-t, --title [title]`
: Sets the task title.

`-s, --status [status]`
: Sets the status of the task. Allowed values are `notStarted`, `inProgress`, `completed`, `waitingOnOthers`, `deferred`.

`--listName [listName]`
: The name of the task list in which the task exists. Specify either `listName` or `listId`, but not both.

`--listId [listId]`
: The id of the task list in which the task exists. Specify either `listName` or `listId`, but not both.

`--bodyContent [bodyContent]`
: The body content of the task. In the UI this is called 'notes'.

`--bodyContentType [bodyContentType]`
: The type of the body content. Allowed values: `text` and `html`. Defaults to `text`.

`--importance [importance]`
: The importance of the task. Allowed values: `low`, `normal`, `high`.

`--dueDateTime [dueDateTime]`
: The date and time when the task is due. This should be defined as a valid ISO 8601 string in the UTC time zone. Only date value is needed, time value is always ignored.

`--reminderDateTime [reminderDateTime]`
: The date and time for a reminder alert of the task to occur. This should be defined as a valid ISO 8601 string in the UTC time zone.

`--categories [categories]`
: Comma-separated list of categories associated with the task.

`--completedDateTime [completedDateTime]`
: The date and time when the task was finished. This should be defined as a valid ISO 8601 string. e.g. `2021-12-16T18:28:48.6964197Z`.

`--startDateTime [startDateTime]`
: The date and time when the task is scheduled to start. This should be defined as a valid ISO 8601 string. e.g. `2021-12-16T18:28:48.6964197Z`.

Remarks

When you specify the values for categories, each category can correspond to the displayName property of an outlookCategory. It is permissible to use distinct names.

Examples

Update a task with title New task to Update doco in Microsoft To Do tasks list with a specific name.

m365 todo task set --id "AAMkADU3Y2E0OTMxLTllYTQtNGFlZS1hZGM0LWI1NjZjY2FhM2RhMABGAAAAAADhr7P77n9xS6PdtDemRwpHBwCin1tvQMXzRKN1hQDz2S3VAAAXXsleAACin1tvQMXzRKN1hQDz2S3VAAAXXzr9AAA=" --title "Update doco" --listName "My task list"

Update a task with status from notStarted to inProgress in Microsoft To Do tasks list with a specific name.

m365 todo task set --id "AAMkADU3Y2E0OTMxLTllYTQtNGFlZS1hZGM0LWI1NjZjY2FhM2RhMABGAAAAAADhr7P77n9xS6PdtDemRwpHBwCin1tvQMXzRKN1hQDz2S3VAAAXXsleAACin1tvQMXzRKN1hQDz2S3VAAAXXzr9AAA=" --status "inProgress" --listName "My task list"

Update a task with bodyContent and reminder and flag it as important in Microsoft To Do tasks list with a specific name.

m365 todo task set --id "AAMkADU3Y2E0OTMxLTllYTQtNGFlZS1hZGM0LWI1NjZjY2FhM2RhMABGAAAAAADhr7P77n9xS6PdtDemRwpHBwCin1tvQMXzRKN1hQDz2S3VAAAXXsleAACin1tvQMXzRKN1hQDz2S3VAAAXXzr9AAA=" --listName "My task list" --bodyContent "I should not forget this" --reminderDateTime 2023-01-01T12:00:00Z --importance high

Update a task with due date in Microsoft To Do tasks list with list id.

m365 todo task set --id "AAMkADU3Y2E0OTMxLTllYTQtNGFlZS1hZGM0LWI1NjZjY2FhM2RhMABGAAAAAADhr7P77n9xS6PdtDemRwpHBwCin1tvQMXzRKN1hQDz2S3VAAAXXsleAACin1tvQMXzRKN1hQDz2S3VAAAXXzr9AAA=" --listId "AQMkADlhMTRkOGEzLWQ1M2QtNGVkNS04NjdmLWU0NzJhMjZmZWNmMwAuAAADKvwNgAMNPE_zFNRJXVrU1wEAhHKQZHItDEOVCn8U3xuA2AABmQeVPwAAAA==" --dueDateTime 2023-01-01

Update a task to Microsoft To Do with several categories.

m365 todo task set --title "New task" --listName "My task list" --categories "Red category,Important"

Update a task to Microsoft To Do with a start date and set a reminder for the task.

m365 todo task set --title "New task" --listName "My task list" --startDateTime "2023-12-16T18:28:48.6964197Z" --isReminderOn true

Response

{
  "importance": "high",
  "isReminderOn": true,
  "status": "notStarted",
  "title": "Update doco",
  "createdDateTime": "2022-10-29T11:03:20.9175176Z",
  "lastModifiedDateTime": "2022-10-30T14:07:03.0718199Z",
  "hasAttachments": false,
  "categories": [],
  "id": "AAMkAGYzNjMxYTU4LTJjZjYtNDlhMi1iMzQ2LWVmMTU3YmUzOGM5MABGAAAAAAAw3-tXgryDSr5p162KnUPKBwDEwEFouXWWT50CfwqSN9cpAAL3xdLTAADEwEFouXWWT50CfwqSN9cpAAL3xhtSAAA=",
  "body": {
    "content": "I should not forget this",
    "contentType": "text"
  },
  "dueDateTime": {
    "dateTime": "2023-01-01T00:00:00.0000000",
    "timeZone": "UTC"
  },
  "reminderDateTime": {
    "dateTime": "2023-01-01T12:00:00.0000000",
    "timeZone": "UTC"
  }
}
body                : {"content":"I should not forget this","contentType":"text"}
categories          : []
createdDateTime     : 2022-10-29T11:03:20.9175176Z
dueDateTime         : {"dateTime":"2023-01-01T00:00:00.0000000","timeZone":"UTC"}
hasAttachments      : false
id                  : AAMkAGYzNjMxYTU4LTJjZjYtNDlhMi1iMzQ2LWVmMTU3YmUzOGM5MABGAAAAAAAw3-tXgryDSr5p162KnUPKBwDEwEFouXWWT50CfwqSN9cpAAL3xdLTAADEwEFouXWWT50CfwqSN9cpAAL3xhtSAAA=
importance          : high
isReminderOn        : true
lastModifiedDateTime: 2022-10-30T14:08:17.6665299Z
reminderDateTime    : {"dateTime":"2023-01-01T12:00:00.0000000","timeZone":"UTC"}
status              : notStarted
title               : Update doco

importance,isReminderOn,status,title,createdDateTime,lastModifiedDateTime,hasAttachments,categories,id,body,dueDateTime,reminderDateTime
high,1,notStarted,Update doco,2022-10-29T11:03:20.9175176Z,2022-10-30T14:09:14.7687057Z,,[],AAMkAGYzNjMxYTU4LTJjZjYtNDlhMi1iMzQ2LWVmMTU3YmUzOGM5MABGAAAAAAAw3-tXgryDSr5p162KnUPKBwDEwEFouXWWT50CfwqSN9cpAAL3xdLTAADEwEFouXWWT50CfwqSN9cpAAL3xhtSAAA=,"{""content"":""I should not forget this"",""contentType"":""text""}","{""dateTime"":""2023-01-01T00:00:00.0000000"",""timeZone"":""UTC""}","{""dateTime"":""2023-01-01T12:00:00.0000000"",""timeZone"":""UTC""}"
# todo task set --id "AAMkAGYzNjMxYTU4LTJjZjYtNDlhMi1iMzQ2LWVmMTU3YmUzOGM5MABGAAAAAAAw3-tXgryDSr5p162KnUPKBwDEwEFouXWWT50CfwqSN9cpAAL3xdLTAADEwEFouXWWT50CfwqSN9cpAAL3xhtSAAA=" --title "Update doco" --listName "My task list" --status "notStarted"

Date: 4/3/2023

## Update doco (AAMkAGYzNjMxYTU4LTJjZjYtNDlhMi1iMzQ2LWVmMTU3YmUzOGM5MABGAAAAAAAw3-tXgryDSr5p162KnUPKBwDEwEFouXWWT50CfwqSN9cpAAL3xdLTAADEwEFouXWWT50CfwqSN9cpAAL3xhtSAAA=)

Property | Value
---------|-------
importance | high
isReminderOn | true
status | notStarted
title | Update doco
createdDateTime | 2022-10-29T11:03:20.9175176Z
lastModifiedDateTime | 2022-10-30T14:07:03.0718199Z
hasAttachments | false
id | AAMkAGYzNjMxYTU4LTJjZjYtNDlhMi1iMzQ2LWVmMTU3YmUzOGM5MABGAAAAAAAw3-tXgryDSr5p162KnUPKBwDEwEFouXWWT50CfwqSN9cpAAL3xdLTAADEwEFouXWWT50CfwqSN9cpAAL3xhtSAAA=
reminderDateTime |  {"dateTime": "2023-01-01T12:00:00.0000000","timeZone": "UTC"}