Update plannerPlanConfigurationLocalization

Article
08/23/2023

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.

Update the properties of a plannerPlanConfigurationLocalization object.

This API is supported 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	Permissions (from least to most privileged)
Delegated (work or school account)	BusinessScenarioConfig.ReadWrite.OwnedBy, BusinessScenarioConfig.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	BusinessScenarioConfig.ReadWrite.OwnedBy

HTTP request

For a specific localization based on a business scenario ID and a localization ID:

PATCH /solutions/businessScenarios/{businessScenarioId}/planner/planConfiguration/localizations/{plannerPlanConfigurationLocalizationId}

For a specific localization based on the unique name of a business scenario and a localization ID:

PATCH /solutions/businessScenarios(uniqueName='{uniqueName}')/planner/planConfiguration/localizations/{plannerPlanConfigurationLocalizationId}

Request headers

Name	Description
Authorization	Bearer {token}. Required.
Content-Type	application/json. Required.

Request body

In the request body, supply only the values for properties that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property	Type	Description
buckets	plannerPlanConfigurationBucketLocalization collection	Localizations for buckets specified in the plannerPlanConfiguration. Optional.
planTitle	String	Localized title of the plan. Optional.

Response

If successful, this method returns a 200 OK response code and an updated plannerPlanConfigurationLocalization object in the response body.

Examples

Request

The following is an example of a request.

PATCH https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations/en-us
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization",
  "planTitle": "Order Tracking",
  "buckets": [
    {
      "externalBucketId": "deliveryBucket",
      "name": "Deliveries"
    },
    {
      "externalBucketId": "storePickupBucket",
      "name": "Pickup"
    },
    {
      "externalBucketId": "specialOrdersBucket",
      "name": "Special Orders"
    },
    {
      "externalBucketId": "returnProcessingBucket",
      "name": "Customer Returns"
    }
  ]
}


// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new PlannerPlanConfigurationLocalization
{
	OdataType = "#microsoft.graph.plannerPlanConfigurationLocalization",
	PlanTitle = "Order Tracking",
	Buckets = new List<PlannerPlanConfigurationBucketLocalization>
	{
		new PlannerPlanConfigurationBucketLocalization
		{
			ExternalBucketId = "deliveryBucket",
			Name = "Deliveries",
		},
		new PlannerPlanConfigurationBucketLocalization
		{
			ExternalBucketId = "storePickupBucket",
			Name = "Pickup",
		},
		new PlannerPlanConfigurationBucketLocalization
		{
			ExternalBucketId = "specialOrdersBucket",
			Name = "Special Orders",
		},
		new PlannerPlanConfigurationBucketLocalization
		{
			ExternalBucketId = "returnProcessingBucket",
			Name = "Customer Returns",
		},
	},
};
var result = await graphClient.Solutions.BusinessScenarios["{businessScenario-id}"].Planner.PlanConfiguration.Localizations["{plannerPlanConfigurationLocalization-id}"].PatchAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta solutions business-scenarios planner plan-configuration localizations patch --business-scenario-id {businessScenario-id} --planner-plan-configuration-localization-id {plannerPlanConfigurationLocalization-id} --body '{\
  "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization",\
  "planTitle": "Order Tracking",\
  "buckets": [\
    {\
      "externalBucketId": "deliveryBucket",\
      "name": "Deliveries"\
    },\
    {\
      "externalBucketId": "storePickupBucket",\
      "name": "Pickup"\
    },\
    {\
      "externalBucketId": "specialOrdersBucket",\
      "name": "Special Orders"\
    },\
    {\
      "externalBucketId": "returnProcessingBucket",\
      "name": "Customer Returns"\
    }\
  ]\
}\
'

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewPlannerPlanConfigurationLocalization()
planTitle := "Order Tracking"
requestBody.SetPlanTitle(&planTitle) 


plannerPlanConfigurationBucketLocalization := graphmodels.NewPlannerPlanConfigurationBucketLocalization()
externalBucketId := "deliveryBucket"
plannerPlanConfigurationBucketLocalization.SetExternalBucketId(&externalBucketId) 
name := "Deliveries"
plannerPlanConfigurationBucketLocalization.SetName(&name) 
plannerPlanConfigurationBucketLocalization1 := graphmodels.NewPlannerPlanConfigurationBucketLocalization()
externalBucketId := "storePickupBucket"
plannerPlanConfigurationBucketLocalization1.SetExternalBucketId(&externalBucketId) 
name := "Pickup"
plannerPlanConfigurationBucketLocalization1.SetName(&name) 
plannerPlanConfigurationBucketLocalization2 := graphmodels.NewPlannerPlanConfigurationBucketLocalization()
externalBucketId := "specialOrdersBucket"
plannerPlanConfigurationBucketLocalization2.SetExternalBucketId(&externalBucketId) 
name := "Special Orders"
plannerPlanConfigurationBucketLocalization2.SetName(&name) 
plannerPlanConfigurationBucketLocalization3 := graphmodels.NewPlannerPlanConfigurationBucketLocalization()
externalBucketId := "returnProcessingBucket"
plannerPlanConfigurationBucketLocalization3.SetExternalBucketId(&externalBucketId) 
name := "Customer Returns"
plannerPlanConfigurationBucketLocalization3.SetName(&name) 

buckets := []graphmodels.PlannerPlanConfigurationBucketLocalizationable {
	plannerPlanConfigurationBucketLocalization,
	plannerPlanConfigurationBucketLocalization1,
	plannerPlanConfigurationBucketLocalization2,
	plannerPlanConfigurationBucketLocalization3,
}
requestBody.SetBuckets(buckets)

localizations, err := graphClient.Solutions().BusinessScenarios().ByBusinessScenarioId("businessScenario-id").Planner().PlanConfiguration().Localizations().ByPlannerPlanConfigurationLocalizationId("plannerPlanConfigurationLocalization-id").Patch(context.Background(), requestBody, nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

PlannerPlanConfigurationLocalization plannerPlanConfigurationLocalization = new PlannerPlanConfigurationLocalization();
plannerPlanConfigurationLocalization.planTitle = "Order Tracking";
LinkedList<PlannerPlanConfigurationBucketLocalization> bucketsList = new LinkedList<PlannerPlanConfigurationBucketLocalization>();
PlannerPlanConfigurationBucketLocalization buckets = new PlannerPlanConfigurationBucketLocalization();
buckets.externalBucketId = "deliveryBucket";
buckets.name = "Deliveries";
bucketsList.add(buckets);
PlannerPlanConfigurationBucketLocalization buckets1 = new PlannerPlanConfigurationBucketLocalization();
buckets1.externalBucketId = "storePickupBucket";
buckets1.name = "Pickup";
bucketsList.add(buckets1);
PlannerPlanConfigurationBucketLocalization buckets2 = new PlannerPlanConfigurationBucketLocalization();
buckets2.externalBucketId = "specialOrdersBucket";
buckets2.name = "Special Orders";
bucketsList.add(buckets2);
PlannerPlanConfigurationBucketLocalization buckets3 = new PlannerPlanConfigurationBucketLocalization();
buckets3.externalBucketId = "returnProcessingBucket";
buckets3.name = "Customer Returns";
bucketsList.add(buckets3);
plannerPlanConfigurationLocalization.buckets = bucketsList;

graphClient.solutions().businessScenarios("c5d514e6c6864911ac46c720affb6e4d").planner().planConfiguration().localizations("en-us")
	.buildRequest()
	.patch(plannerPlanConfigurationLocalization);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const plannerPlanConfigurationLocalization = {
  '@odata.type': '#microsoft.graph.plannerPlanConfigurationLocalization',
  planTitle: 'Order Tracking',
  buckets: [
    {
      externalBucketId: 'deliveryBucket',
      name: 'Deliveries'
    },
    {
      externalBucketId: 'storePickupBucket',
      name: 'Pickup'
    },
    {
      externalBucketId: 'specialOrdersBucket',
      name: 'Special Orders'
    },
    {
      externalBucketId: 'returnProcessingBucket',
      name: 'Customer Returns'
    }
  ]
};

await client.api('/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations/en-us')
	.version('beta')
	.update(plannerPlanConfigurationLocalization);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php

// THIS SNIPPET IS A PREVIEW VERSION OF THE SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new PlannerPlanConfigurationLocalization();
$requestBody->setOdataType('#microsoft.graph.plannerPlanConfigurationLocalization');
$requestBody->setPlanTitle('Order Tracking');
$bucketsPlannerPlanConfigurationBucketLocalization1 = new PlannerPlanConfigurationBucketLocalization();
$bucketsPlannerPlanConfigurationBucketLocalization1->setExternalBucketId('deliveryBucket');
$bucketsPlannerPlanConfigurationBucketLocalization1->setName('Deliveries');
$bucketsArray []= $bucketsPlannerPlanConfigurationBucketLocalization1;
$bucketsPlannerPlanConfigurationBucketLocalization2 = new PlannerPlanConfigurationBucketLocalization();
$bucketsPlannerPlanConfigurationBucketLocalization2->setExternalBucketId('storePickupBucket');
$bucketsPlannerPlanConfigurationBucketLocalization2->setName('Pickup');
$bucketsArray []= $bucketsPlannerPlanConfigurationBucketLocalization2;
$bucketsPlannerPlanConfigurationBucketLocalization3 = new PlannerPlanConfigurationBucketLocalization();
$bucketsPlannerPlanConfigurationBucketLocalization3->setExternalBucketId('specialOrdersBucket');
$bucketsPlannerPlanConfigurationBucketLocalization3->setName('Special Orders');
$bucketsArray []= $bucketsPlannerPlanConfigurationBucketLocalization3;
$bucketsPlannerPlanConfigurationBucketLocalization4 = new PlannerPlanConfigurationBucketLocalization();
$bucketsPlannerPlanConfigurationBucketLocalization4->setExternalBucketId('returnProcessingBucket');
$bucketsPlannerPlanConfigurationBucketLocalization4->setName('Customer Returns');
$bucketsArray []= $bucketsPlannerPlanConfigurationBucketLocalization4;
$requestBody->setBuckets($bucketsArray);


$result = $graphServiceClient->solutions()->businessScenarios()->byBusinessScenarioId('businessScenario-id')->planner()->planConfiguration()->localizations()->byPlannerPlanConfigurationLocalizationId('plannerPlanConfigurationLocalization-id')->patch($requestBody)->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Beta.Bookings

$params = @{
	"@odata.type" = "#microsoft.graph.plannerPlanConfigurationLocalization"
	planTitle = "Order Tracking"
	buckets = @(
		@{
			externalBucketId = "deliveryBucket"
			name = "Deliveries"
		}
		@{
			externalBucketId = "storePickupBucket"
			name = "Pickup"
		}
		@{
			externalBucketId = "specialOrdersBucket"
			name = "Special Orders"
		}
		@{
			externalBucketId = "returnProcessingBucket"
			name = "Customer Returns"
		}
	)
}

Update-MgBetaBusinessScenarioPlannerPlanConfigurationLocalization -BusinessScenarioId $businessScenarioId -PlannerPlanConfigurationLocalizationId $plannerPlanConfigurationLocalizationId -BodyParameter $params

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# THE PYTHON SDK IS IN PREVIEW. FOR NON-PRODUCTION USE ONLY

graph_client = GraphServiceClient(request_adapter)

request_body = PlannerPlanConfigurationLocalization(
	odata_type = "#microsoft.graph.plannerPlanConfigurationLocalization",
	plan_title = "Order Tracking",
	buckets = [
		PlannerPlanConfigurationBucketLocalization(
			external_bucket_id = "deliveryBucket",
			name = "Deliveries",
		),
		PlannerPlanConfigurationBucketLocalization(
			external_bucket_id = "storePickupBucket",
			name = "Pickup",
		),
		PlannerPlanConfigurationBucketLocalization(
			external_bucket_id = "specialOrdersBucket",
			name = "Special Orders",
		),
		PlannerPlanConfigurationBucketLocalization(
			external_bucket_id = "returnProcessingBucket",
			name = "Customer Returns",
		),
	]
)

result = await graph_client.solutions.busine_scenarios.by_busine_scenario_id('businessScenario-id').planner.plan_configuration.localizations.by_localization_id('plannerPlanConfigurationLocalization-id').patch(body = request_body)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization",
  "id": "en-us",
  "languageTag": "en-us",
  "planTitle": "Order Tracking",
  "buckets": [
    {
      "externalBucketId": "deliveryBucket",
      "name": "Deliveries"
    },
    {
      "externalBucketId": "storePickupBucket",
      "name": "Pickup"
    },
    {
      "externalBucketId": "specialOrdersBucket",
      "name": "Special Orders"
    },
    {
      "externalBucketId": "returnProcessingBucket",
      "name": "Customer Returns"
    }
  ]
}

Update plannerPlanConfigurationLocalization

Permissions

HTTP request

Request headers

Request body

Response

Examples

Request

Response

Feedback

Additional resources

Additional resources