plannerPlan: archive

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

存档 plannerPlan 对象。 存档计划,还会在计划中存档 plannerTasksplannerBuckets

已存档实体是只读的。 无法更新已存档实体。

存档的计划可以 取消存档

可以删除所有已存档实体。

已存档的任务不包括在 分配给用户的任务的响应列表中

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

要调用此 API,需要以下权限之一。 若要了解详细信息,包括如何选择权限的信息,请参阅权限

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Tasks.ReadWrite 不可用。
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 Tasks.ReadWrite.All 不可用。

HTTP 请求

POST /planner/plans/{planId}/archive

请求标头

名称 说明
Authorization 持有者 {token}。 必填。
Content-Type application/json. 必需。
If-Match 要存档 的 plannerPlan 的最后一个已知 ETag 值。 必填。

请求正文

在请求正文中,提供参数的 JSON 表示形式。

下表列出了调用此操作时所需的参数。

参数 类型 说明
理由 String 计划存档的原因。

响应

如果成功,此操作返回 204 No Content 响应代码。

此方法可以返回任何 HTTP 状态代码。 应用应对此方法处理的最常见错误是 400 和 403 响应。 有关这些错误的详细信息,请参阅 Common Planner 错误条件

示例

请求

以下示例显示了一个请求。

POST https://graph.microsoft.com/beta/planner/plans/{planId}/archive
Content-Type: application/json

{
  "justification": "String"
}

响应

以下示例显示了相应的响应。

注意:为了提高可读性,可能缩短了此处显示的响应对象。

HTTP/1.1 204 No Content