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.
Unarchive a plannerPlan object. Unarchiving a plan, also unarchives the plannerTasks and plannerBuckets in the plan.
Only a plan that is archived can be unarchived.
This API is available in the following national cloud deployments.
Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
✅ |
✅ |
✅ |
❌ |
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}/unarchive
Name |
Description |
Authorization |
Bearer {token}. Required. |
Content-Type |
application/json. Required. |
If-Match |
Last known ETag value for the plannerPlan to be unarchived. 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 unarchived. |
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}/unarchive
Content-Type: application/json
{
"justification": "String"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Planner.Plans.Item.Unarchive;
var requestBody = new UnarchivePostRequestBody
{
Justification = "String",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Planner.Plans["{plannerPlan-id}"].Unarchive.PostAsync(requestBody);
// 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"
graphplanner "github.com/microsoftgraph/msgraph-beta-sdk-go/planner"
//other-imports
)
requestBody := graphplanner.NewUnarchivePostRequestBody()
justification := "String"
requestBody.SetJustification(&justification)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Planner().Plans().ByPlannerPlanId("plannerPlan-id").Unarchive().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.planner.plans.item.unarchive.UnarchivePostRequestBody unarchivePostRequestBody = new com.microsoft.graph.beta.planner.plans.item.unarchive.UnarchivePostRequestBody();
unarchivePostRequestBody.setJustification("String");
graphClient.planner().plans().byPlannerPlanId("{plannerPlan-id}").unarchive().post(unarchivePostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const unarchive = {
justification: 'String'
};
await client.api('/planner/plans/{planId}/unarchive')
.version('beta')
.post(unarchive);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Planner\Plans\Item\Unarchive\UnarchivePostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new UnarchivePostRequestBody();
$requestBody->setJustification('String');
$graphServiceClient->planner()->plans()->byPlannerPlanId('plannerPlan-id')->unarchive()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Planner
$params = @{
justification = "String"
}
Invoke-MgBetaUnarchivePlannerPlan -PlannerPlanId $plannerPlanId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.planner.plans.item.unarchive.unarchive_post_request_body import UnarchivePostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = UnarchivePostRequestBody(
justification = "String",
)
await graph_client.planner.plans.by_planner_plan_id('plannerPlan-id').unarchive.post(request_body)
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 204 No Content