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.
Move a planner plan object from one planner plan container to another. Planner plans can only be moved from a user container to a group container.
This API is available in the following national cloud deployments.
Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
✅ |
✅ |
✅ |
❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type |
Least privileged permissions |
Higher privileged permissions |
Delegated (work or school account) |
Tasks.Read |
Tasks.ReadWrite |
Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
Application |
Tasks.Read.All |
Tasks.ReadWrite.All |
HTTP request
POST /planner/plans/{planId}/moveToContainer
Name |
Description |
Authorization |
Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type |
application/json. Required. |
If-Match |
Last known ETag value for the plannerPlan to be moved. Required. |
Request body
In the request body, supply a JSON representation of the plannerPlanContainer object.
Response
If successful, this API returns a 200 OK
response code and a plannerPlan object in the response body.
Example
Request
The following example shows a request to move a plan from a user container to a group container.
POST https://graph.microsoft.com/beta/planner/plans/{planId}/moveToContainer
Content-type: application/json
If-Match: "string"
{
"container": {
"containerId": "groupId",
"type": "group"
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Planner.Plans.Item.MoveToContainer;
using Microsoft.Graph.Beta.Models;
var requestBody = new MoveToContainerPostRequestBody
{
Container = new PlannerPlanContainer
{
ContainerId = "groupId",
Type = PlannerContainerType.Group,
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Planner.Plans["{plannerPlan-id}"].MoveToContainer.PostAsync(requestBody, (requestConfiguration) =>
{
requestConfiguration.Headers.Add("If-Match", "\"string\"");
});
mgc-beta planner plans move-to-container post --planner-plan-id {plannerPlan-id} --body '{\
"container": {\
"containerId": "groupId",\
"type": "group"\
}\
}\
'
// 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"
graphplanner "github.com/microsoftgraph/msgraph-beta-sdk-go/planner"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
headers := abstractions.NewRequestHeaders()
headers.Add("If-Match", "\"string\"")
configuration := &graphplanner.PlansItemMoveToContainerRequestBuilderPostRequestConfiguration{
Headers: headers,
}
requestBody := graphplanner.NewMoveToContainerPostRequestBody()
container := graphmodels.NewPlannerPlanContainer()
containerId := "groupId"
container.SetContainerId(&containerId)
type := graphmodels.GROUP_PLANNERCONTAINERTYPE
container.SetType(&type)
requestBody.SetContainer(container)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
moveToContainer, err := graphClient.Planner().Plans().ByPlannerPlanId("plannerPlan-id").MoveToContainer().Post(context.Background(), requestBody, configuration)
// 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.movetocontainer.MoveToContainerPostRequestBody moveToContainerPostRequestBody = new com.microsoft.graph.beta.planner.plans.item.movetocontainer.MoveToContainerPostRequestBody();
PlannerPlanContainer container = new PlannerPlanContainer();
container.setContainerId("groupId");
container.setType(PlannerContainerType.Group);
moveToContainerPostRequestBody.setContainer(container);
var result = graphClient.planner().plans().byPlannerPlanId("{plannerPlan-id}").moveToContainer().post(moveToContainerPostRequestBody, requestConfiguration -> {
requestConfiguration.headers.add("If-Match", "\"string\"");
});
const options = {
authProvider,
};
const client = Client.init(options);
const plannerPlan = {
container: {
containerId: 'groupId',
type: 'group'
}
};
await client.api('/planner/plans/{planId}/moveToContainer')
.version('beta')
.post(plannerPlan);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Planner\Plans\Item\MoveToContainer\MoveToContainerRequestBuilderPostRequestConfiguration;
use Microsoft\Graph\Beta\Generated\Planner\Plans\Item\MoveToContainer\MoveToContainerPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\PlannerPlanContainer;
use Microsoft\Graph\Beta\Generated\Models\PlannerContainerType;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new MoveToContainerPostRequestBody();
$container = new PlannerPlanContainer();
$container->setContainerId('groupId');
$container->setType(new PlannerContainerType('group'));
$requestBody->setContainer($container);
$requestConfiguration = new MoveToContainerRequestBuilderPostRequestConfiguration();
$headers = [
'If-Match' => '"string"',
];
$requestConfiguration->headers = $headers;
$result = $graphServiceClient->planner()->plans()->byPlannerPlanId('plannerPlan-id')->moveToContainer()->post($requestBody, $requestConfiguration)->wait();
Import-Module Microsoft.Graph.Beta.Planner
$params = @{
container = @{
containerId = "groupId"
type = "group"
}
}
Move-MgBetaPlannerPlanToContainer -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.move_to_container.move_to_container_request_builder import MoveToContainerRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
from msgraph_beta.generated.planner.plans.item.move_to_container.move_to_container_post_request_body import MoveToContainerPostRequestBody
from msgraph_beta.generated.models.planner_plan_container import PlannerPlanContainer
from msgraph_beta.generated.models.planner_container_type import PlannerContainerType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = MoveToContainerPostRequestBody(
container = PlannerPlanContainer(
container_id = "groupId",
type = PlannerContainerType.Group,
),
)
request_configuration = RequestConfiguration()
request_configuration.headers.add("If-Match", "\"string\"")
result = await graph_client.planner.plans.by_planner_plan_id('plannerPlan-id').move_to_container.post(request_body, request_configuration = request_configuration)
Response
The following example shows a response to a request to move a plan from a user container to a group container.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#plans/$entity",
"@odata.etag": "W/\"JzEtUGxhbiAgQEBAQEBAQEBAQEBAQEBARCc=\"",
"title": "The Plan",
"id": "planId",
"container": {
"containerId": "groupId",
"type": "group",
"url": "https://graph.microsoft.com/beta/groups/groupId"
}
}