| title | plannerPlan: archive |
|---|---|
| description | Archive a plan |
| author | dianambb |
| ms.localizationpriority | medium |
| ms.subservice | planner |
| doc_type | apiPageType |
| ms.date | 07/16/2024 |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
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.
[!INCLUDE national-cloud-support]
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
[!INCLUDE permissions-table]
POST /planner/plans/{planId}/archive| Name | Description |
|---|---|
| Authorization | Bearer {token}. Required. |
| Content-Type | application/json. Required. |
| If-Match | Last known ETag value for the plannerPlan to be archived. Required. |
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. |
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.
The following example shows a request.
POST https://graph.microsoft.com/beta/planner/plans/{planId}/archive
Content-Type: application/json
{
"justification": "String"
}[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 204 No Content