plannerPlan: archive

  • Article

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Archive a plannerPlan object. Archiving a plan, also archives the plannerTasks and plannerBuckets in the plan.

An archived entity is read-only. Archived entities cannot be updated.

An archived plan can be unarchived.

All archived entities can be deleted.

Archived tasks are not included in the response for list of tasks assigned to a user.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Tasks.ReadWrite Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Tasks.ReadWrite.All Not available.

HTTP request

POST /planner/plans/{planId}/archive

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.
If-Match Last known ETag value for the plannerPlan to be archived. Required.

Request body

In the request body, supply a JSON representation of the parameters.

The following table lists the parameters that are required when you call this action.

Parameter Type Description
justification String Reason why the plan is being archived.

Response

If successful, this action returns a 204 No Content response code.

This method can return any of the HTTP status codes. The most common errors that apps should handle for this method are the 400 and 403 responses. For more information about these errors, see Common Planner error conditions.

Examples

Request

The following example shows a request.

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

{
  "justification": "String"
}

Response

The following example shows the response.

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

HTTP/1.1 204 No Content