命名空间：microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
警告
Outlook 任务 API 已于 2022 年 8 月 20 日弃用并停止返回数据。 请改用 “To Do API ”。
获取用户邮箱中的 Outlook 任务的属性和关系。
默认情况下，此操作 (POST、PATCH 和 完成 任务操作，) UTC 返回与日期相关的属性。 你可以使用 Prefer: outlook.timezone 标头将响应中的所有与日期相关的属性都表示为与 UTC 不同的时区。
此 API 可用于以下国家级云部署。
| 全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
| ✅ |
✅ |
✅ |
❌ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。
| 权限类型 |
最低特权权限 |
更高特权权限 |
| 委派（工作或学校帐户） |
Tasks.Read |
不可用。 |
| 委派（个人 Microsoft 帐户） |
Tasks.Read |
不可用。 |
| 应用程序 |
不支持。 |
不支持。 |
HTTP 请求
GET /me/outlook/tasks/{id}
GET /users/{id|userPrincipalName}/outlook/tasks/{id}
可选的查询参数
此方法支持 OData 查询参数 来帮助自定义响应。
| 名称 |
说明 |
| Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
| Prefer: outlook.timezone |
指定响应中时间属性的时区，如果未指定此标头，则为 UTC。 可选。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功，此方法在 200 OK 响应正文中返回响应代码和 outlookTask 对象。
示例
示例 1：获取 Outlook 任务
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/me/outlook/tasks/AAMkADA1MTrgAAA=
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Outlook.Tasks["{outlookTask-id}"].GetAsync();
mgc-beta users outlook tasks get --user-id {user-id} --outlook-task-id {outlookTask-id}
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
//other-imports
)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
tasks, err := graphClient.Me().Outlook().Tasks().ByOutlookTaskId("outlookTask-id").Get(context.Background(), nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
OutlookTask result = graphClient.me().outlook().tasks().byOutlookTaskId("{outlookTask-id}").get();
const options = {
authProvider,
};
const client = Client.init(options);
let outlookTask = await client.api('/me/outlook/tasks/AAMkADA1MTrgAAA=')
.version('beta')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->me()->outlook()->tasks()->byOutlookTaskId('outlookTask-id')->get()->wait();
Import-Module Microsoft.Graph.Beta.Users
# A UPN can also be used as -UserId.
Get-MgBetaUserOutlookTask -UserId $userId -OutlookTaskId $outlookTaskId
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
result = await graph_client.me.outlook.tasks.by_outlook_task_id('outlookTask-id').get()
响应
以下示例显示了相应的响应。 默认情况下，响应中的 date-time 属性采用的是 UTC。
注意：为了提高可读性，可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "AAMkADA1MTrgAAA=",
"createdDateTime": "2016-04-22T06:03:35.9279794Z",
"lastModifiedDateTime": "2016-04-22T06:03:35.9436052Z",
"changeKey": "1/KC9Vmu40G3DwB6Lgs7MAAAIOJMyQ==",
"categories": [],
"assignedTo": null,
"body": {
"contentType": "text",
"content": ""
},
"completedDateTime": null,
"dueDateTime": {
"dateTime": "2016-04-27T04:00:00.0000000",
"timeZone": "UTC"
},
"hasAttachments": false,
"importance": "normal",
"isReminderOn": false,
"owner": "Administrator",
"parentFolderId": "AQMkADA1MTBEgAAAA==",
"recurrence": null,
"reminderDateTime": null,
"sensitivity": "normal",
"startDateTime": {
"dateTime": "2016-04-26T04:00:00.0000000",
"timeZone": "UTC"
},
"status": "notStarted",
"subject": "Shop for dinner"
}
示例 2：获取具有太平洋标准时间的日期时间属性的 Outlook 任务
请求
此示例使用 Prefer: outlook.timezone 标头指定 API 应在太平洋标准时间的响应中返回日期-时间属性。
GET https://graph.microsoft.com/beta/me/outlook/tasks/AAMkADA1MHgwAAA=
Prefer: outlook.timezone="Pacific Standard Time"
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Outlook.Tasks["{outlookTask-id}"].GetAsync((requestConfiguration) =>
{
requestConfiguration.Headers.Add("Prefer", "outlook.timezone=\"Pacific Standard Time\"");
});
mgc-beta users outlook tasks get --user-id {user-id} --outlook-task-id {outlookTask-id}
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
abstractions "github.com/microsoft/kiota-abstractions-go"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphusers "github.com/microsoftgraph/msgraph-beta-sdk-go/users"
//other-imports
)
headers := abstractions.NewRequestHeaders()
headers.Add("Prefer", "outlook.timezone=\"Pacific Standard Time\"")
configuration := &graphusers.OutlookTasksItemRequestBuilderGetRequestConfiguration{
Headers: headers,
}
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
tasks, err := graphClient.Me().Outlook().Tasks().ByOutlookTaskId("outlookTask-id").Get(context.Background(), configuration)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
OutlookTask result = graphClient.me().outlook().tasks().byOutlookTaskId("{outlookTask-id}").get(requestConfiguration -> {
requestConfiguration.headers.add("Prefer", "outlook.timezone=\"Pacific Standard Time\"");
});
const options = {
authProvider,
};
const client = Client.init(options);
let outlookTask = await client.api('/me/outlook/tasks/AAMkADA1MHgwAAA=')
.version('beta')
.header('Prefer','outlook.timezone="Pacific Standard Time"')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Users\Item\Outlook\Tasks\Item\OutlookTaskItemRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new OutlookTaskItemRequestBuilderGetRequestConfiguration();
$headers = [
'Prefer' => 'outlook.timezone="Pacific Standard Time"',
];
$requestConfiguration->headers = $headers;
$result = $graphServiceClient->me()->outlook()->tasks()->byOutlookTaskId('outlookTask-id')->get($requestConfiguration)->wait();
Import-Module Microsoft.Graph.Beta.Users
# A UPN can also be used as -UserId.
Get-MgBetaUserOutlookTask -UserId $userId -OutlookTaskId $outlookTaskId
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.users.item.outlook.tasks.item.outlook_task_item_request_builder import OutlookTaskItemRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_configuration = RequestConfiguration()
request_configuration.headers.add("Prefer", "outlook.timezone=\"Pacific Standard Time\"")
result = await graph_client.me.outlook.tasks.by_outlook_task_id('outlookTask-id').get(request_configuration = request_configuration)
响应
以下示例显示了相应的响应。 响应中的日期-时间属性在指定的太平洋标准时间返回。
注意：为了提高可读性，可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "AAMkADA1MHgwAAA=",
"createdDateTime": "2016-04-22T15:19:18.9526004-07:00",
"lastModifiedDateTime": "2016-04-22T15:19:19.015101-07:00",
"changeKey": "1/KC9Vmu40G3DwB6Lgs7MAAAIW9XXA==",
"categories": [],
"assignedTo": "Dana Swope",
"body": {
"contentType": "text",
"content": ""
},
"completedDateTime": null,
"dueDateTime": {
"dateTime": "2016-05-04T021:00:00.0000000",
"timeZone": "Pacific Standard Time"
},
"hasAttachments": false,
"importance": "normal",
"isReminderOn": false,
"owner": "Administrator",
"parentFolderId": "AQMkADA1MTEgAAAA==",
"recurrence": null,
"reminderDateTime": null,
"sensitivity": "normal",
"startDateTime": {
"dateTime": "2016-05-02T21:00:00.0000000",
"timeZone": "Pacific Standard Time"
},
"status": "notStarted",
"subject": "Shop for children's weekend"
}