baseTask の作成 (非推奨)

[アーティクル]
10/28/2023

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

注意

baseTask 上に構築された To Do API セットは、2022 年 5 月 31 日より非推奨となり、2022 年 8 月 31 日にデータの返しを停止します。 todoTask 上に構築された API セットを使用してください。

特定の baseTaskList に新しい baseTask オブジェクトを作成します。

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、アクセス許可のリファレンスを参照してください。

アクセス許可の種類	最小特権アクセス許可	特権の高いアクセス許可
委任 (職場または学校のアカウント)	Tasks.ReadWrite	注意事項なし。
委任 (個人用 Microsoft アカウント)	Tasks.ReadWrite	注意事項なし。
アプリケーション	サポートされていません。	サポートされていません。

HTTP 要求

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

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と承認の詳細については、こちらをご覧ください。
Content-Type	application/json. 必須です。

要求本文

要求本文で、 baseTask オブジェクトの JSON 表現を指定します。

baseTask を作成するときに、次のプロパティを指定できます。

プロパティ	型	説明
textBody	String	通常、タスクに関する情報を含むテキスト形式のタスク本文。
createdDateTime	DateTimeOffset	タスクが終了した日付 (指定のタイムゾーン)。
lastModifiedDateTime	DateTimeOffset	タスクが最後に変更された日時。既定では、UTC 時間です。要求ヘッダーでカスタムタイムゾーンを使用できます。プロパティの値は、ISO 8601 形式を使って表され、常に UTC 時間です。たとえば、2020 年 1 月 1 日の午前 0 時 UTC は、'2020-01-01T00:00:00Z' のようになります。
bodyLastModifiedDateTime	DateTimeOffset	タスクが最後に変更された日時。既定では、UTC 時間です。要求ヘッダーでカスタムタイムゾーンを使用できます。プロパティの値は、ISO 8601 形式を使って表され、常に UTC 時間です。たとえば、2020 年 1 月 1 日の午前 0 時 UTC は、'2020-01-01T00:00:00Z' のようになります。
CompletedDateTime	DateTimeOffset	タスクが終了した日付 (指定のタイムゾーン)。
dueDateTime	dateTimeTimeZone	タスクが終了する予定の日時 (指定のタイムゾーン)。
startDateTime	dateTimeTimeZone	タスクを開始する日付 (指定のタイムゾーン)。
importance	importance	タスクの重要性。使用可能な値: `low`、`normal`、`high`。
recurrence	patternedRecurrence	タスクの繰り返しパターン。
displayName	String	タスクの簡単な説明。
status	taskStatus_v2	タスクの状態または進行状況を示します。使用可能な値: `notStarted`、`inProgress`、`completed`、`unknownFutureValue`。必須です。
視点	taskViewpoint	reminderDateTime などのユーザーに個人用のプロパティ。

応答

成功した場合、このメソッドは 201 Created 応答コードと、応答本文に baseTask オブジェクトを返します。

例

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"
  }
}


const options = {
	authProvider,
};

const client = Client.init(options);

const tasks = {
  '@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'
  }
};

await client.api('/me/tasks/lists/AQMkAGVjMzJmMWZjLTgyYjgtNGIyNi1hOGQ0LWRjMjNmMGRmOWNi/tasks')
	.version('beta')
	.post(tasks);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用可能なすべての型、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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"
    }
}