Skip to content

basetasklist-post-tasks.md

Latest commit

 

History

History
159 lines (133 loc) · 6.27 KB

basetasklist-post-tasks.md

File metadata and controls

159 lines (133 loc) · 6.27 KB
title Create baseTask
description Create a new baseTask object in a specific baseTaskList.
author devindrajit
ms.localizationpriority medium
ms.subservice outlook
doc_type apiPageType
ms.date 04/05/2024

Create baseTask (deprecated)

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

[!INCLUDE todo-deprecate-basetaskapi]

Create a new baseTask object in a specific baseTaskList.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

POST /me/tasks/lists/{baseTaskListId}/tasks
POST /users/{userId|userPrincipalName}/tasks/lists/{baseTaskListId}/tasks

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the baseTask object.

You can specify the following properties when creating a baseTask.

Property Type Description
textBody String The task body in text format that typically contains information about the task.
createdDateTime DateTimeOffset The date in the specified time zone that the task was finished.
lastModifiedDateTime DateTimeOffset The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.
bodyLastModifiedDateTime DateTimeOffset The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.
completedDateTime DateTimeOffset The date in the specified time zone that the task was finished.
dueDateTime dateTimeTimeZone The date in the specified time zone that the task is to be finished.
startDateTime dateTimeTimeZone The date in the specified time zone when the task is to begin.
importance importance The importance of the task. The possible values are: low, normal, high.
recurrence patternedRecurrence The recurrence pattern for the task.
displayName String A brief description of the task.
status taskStatus_v2 Indicates the state or progress of the task. The possible values are: notStarted, inProgress, completed, unknownFutureValue. Required.
viewpoint taskViewpoint Properties that are personal to a user such as reminderDateTime.

Response

If successful, this method returns a 201 Created response code and a baseTask object in the response body.

Examples

Request

HTTP

POST https://graph.microsoft.com/beta/me/tasks/lists/AQMkAGVjMzJmMWZjLTgyYjgtNGIyNi1hOGQ0LWRjMjNmMGRmOWNi/tasks
Content-Type: application/json
Content-length: 634

{
  "@odata.type": "#microsoft.graph.task",
  "textBody":  "String",
  "bodyLastModifiedDateTime": "String (timestamp)",
  "completedDateTime": "String (timestamp)",
  "dueDateTime": {
    "@odata.type": "microsoft.graph.dateTimeTimeZone"
  },
  "startDateTime": {
    "@odata.type": "microsoft.graph.dateTimeTimeZone"
  },
  "importance": "String",
  "recurrence": {
    "@odata.type": "microsoft.graph.patternedRecurrence"
  },
  "displayName": "String",
  "status": "String",
  "viewpoint": {
    "@odata.type": "microsoft.graph.taskViewpoint"
  }
}

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.task",
    "@odata.etag": "W/\"kOO4xOT//0qFRAqk3TNe0QAABCE1Xg==\"",
    "importance": "normal",
    "status": "notStarted",
    "displayName": "Buy medicine",
    "createdDateTime": "2021-11-17T10:11:18.0229364Z",
    "lastModifiedDateTime": "2021-11-17T10:11:18.19789Z",
    "id": "AAkALgAAAAAAHYQDEapmEc2byACqAC",
    "textBody":  "",
    "parentList": {
        "id": "AQMkAGVjMzJmMWZjLTgyYjgtNGIyNi1hOGQ0LWRjMjNmMGRmOWNi"
    }
}