Create plannerPlanConfigurationLocalization

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.

Create a new plannerPlanConfigurationLocalization object.

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)	BusinessScenarioConfig.ReadWrite.OwnedBy	BusinessScenarioConfig.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	BusinessScenarioConfig.ReadWrite.OwnedBy	Not available.

HTTP request

For a specific localization based on a business scenario ID:

POST /solutions/businessScenarios/{businessScenarioId}/planner/planConfiguration/localizations

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

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

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the plannerPlanConfigurationLocalization object.

You can specify the following properties when you create a plannerPlanConfigurationLocalization.

Property	Type	Description
buckets	plannerPlanConfigurationBucketLocalization collection	Localizations for buckets specified in the plannerPlanConfiguration. Required.
languageTag	String	The code for the language the localized data is intended for. Required.
planTitle	String	Localized title of the plan. Required.

Response

If successful, this method returns a 201 Created response code and a plannerPlanConfigurationLocalization object in the response body.

Examples

Request

The following example shows a request.

HTTP

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

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

C#

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

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new PlannerPlanConfigurationLocalization
{
	OdataType = "#microsoft.graph.plannerPlanConfigurationLocalization",
	LanguageTag = "en-us",
	PlanTitle = "Order Tracking",
	Buckets = new List<PlannerPlanConfigurationBucketLocalization>
	{
		new PlannerPlanConfigurationBucketLocalization
		{
			OdataType = "microsoft.graph.plannerPlanConfigurationBucketLocalization",
			ExternalBucketId = "deliveryBucket",
			Name = "Deliveries",
		},
		new PlannerPlanConfigurationBucketLocalization
		{
			OdataType = "microsoft.graph.plannerPlanConfigurationBucketLocalization",
			ExternalBucketId = "storePickupBucket",
			Name = "Pickup",
		},
		new PlannerPlanConfigurationBucketLocalization
		{
			OdataType = "microsoft.graph.plannerPlanConfigurationBucketLocalization",
			ExternalBucketId = "specialOrdersBucket",
			Name = "Special Orders",
		},
		new PlannerPlanConfigurationBucketLocalization
		{
			OdataType = "microsoft.graph.plannerPlanConfigurationBucketLocalization",
			ExternalBucketId = "returnProcessingBucket",
			Name = "Customer Returns",
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Solutions.BusinessScenarios["{businessScenario-id}"].Planner.PlanConfiguration.Localizations.PostAsync(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.

CLI

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

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.

Go

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()
languageTag := "en-us"
requestBody.SetLanguageTag(&languageTag) 
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().Post(context.Background(), requestBody, nil)

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.

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

PlannerPlanConfigurationLocalization plannerPlanConfigurationLocalization = new PlannerPlanConfigurationLocalization();
plannerPlanConfigurationLocalization.setOdataType("#microsoft.graph.plannerPlanConfigurationLocalization");
plannerPlanConfigurationLocalization.setLanguageTag("en-us");
plannerPlanConfigurationLocalization.setPlanTitle("Order Tracking");
LinkedList<PlannerPlanConfigurationBucketLocalization> buckets = new LinkedList<PlannerPlanConfigurationBucketLocalization>();
PlannerPlanConfigurationBucketLocalization plannerPlanConfigurationBucketLocalization = new PlannerPlanConfigurationBucketLocalization();
plannerPlanConfigurationBucketLocalization.setOdataType("microsoft.graph.plannerPlanConfigurationBucketLocalization");
plannerPlanConfigurationBucketLocalization.setExternalBucketId("deliveryBucket");
plannerPlanConfigurationBucketLocalization.setName("Deliveries");
buckets.add(plannerPlanConfigurationBucketLocalization);
PlannerPlanConfigurationBucketLocalization plannerPlanConfigurationBucketLocalization1 = new PlannerPlanConfigurationBucketLocalization();
plannerPlanConfigurationBucketLocalization1.setOdataType("microsoft.graph.plannerPlanConfigurationBucketLocalization");
plannerPlanConfigurationBucketLocalization1.setExternalBucketId("storePickupBucket");
plannerPlanConfigurationBucketLocalization1.setName("Pickup");
buckets.add(plannerPlanConfigurationBucketLocalization1);
PlannerPlanConfigurationBucketLocalization plannerPlanConfigurationBucketLocalization2 = new PlannerPlanConfigurationBucketLocalization();
plannerPlanConfigurationBucketLocalization2.setOdataType("microsoft.graph.plannerPlanConfigurationBucketLocalization");
plannerPlanConfigurationBucketLocalization2.setExternalBucketId("specialOrdersBucket");
plannerPlanConfigurationBucketLocalization2.setName("Special Orders");
buckets.add(plannerPlanConfigurationBucketLocalization2);
PlannerPlanConfigurationBucketLocalization plannerPlanConfigurationBucketLocalization3 = new PlannerPlanConfigurationBucketLocalization();
plannerPlanConfigurationBucketLocalization3.setOdataType("microsoft.graph.plannerPlanConfigurationBucketLocalization");
plannerPlanConfigurationBucketLocalization3.setExternalBucketId("returnProcessingBucket");
plannerPlanConfigurationBucketLocalization3.setName("Customer Returns");
buckets.add(plannerPlanConfigurationBucketLocalization3);
plannerPlanConfigurationLocalization.setBuckets(buckets);
PlannerPlanConfigurationLocalization result = graphClient.solutions().businessScenarios().byBusinessScenarioId("{businessScenario-id}").planner().planConfiguration().localizations().post(plannerPlanConfigurationLocalization);

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.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

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

await client.api('/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations')
	.version('beta')
	.post(plannerPlanConfigurationLocalization);

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.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\PlannerPlanConfigurationLocalization;
use Microsoft\Graph\Generated\Models\PlannerPlanConfigurationBucketLocalization;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

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


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

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.

PowerShell

Import-Module Microsoft.Graph.Beta.Bookings

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

New-MgBetaBusinessScenarioPlannerPlanConfigurationLocalization -BusinessScenarioId $businessScenarioId -BodyParameter $params

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.

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.planner_plan_configuration_localization import PlannerPlanConfigurationLocalization
from msgraph.generated.models.planner_plan_configuration_bucket_localization import PlannerPlanConfigurationBucketLocalization

graph_client = GraphServiceClient(credentials, scopes)

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

result = await graph_client.solutions.business_scenarios.by_business_scenario_id('businessScenario-id').planner.plan_configuration.localizations.post(request_body)

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.

Response

The following example shows the response.

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

HTTP/1.1 201 Created
Content-Type: application/json

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