List plannerPlanConfigurationLocalizations

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.

Get a list of the plannerPlanConfigurationLocalization objects and their properties.

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

HTTP request

For localizations based on a business scenario ID:

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

For localizations based on the unique name of a business scenario:

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

Optional query parameters

This method supports some of the OData query parameters to help customize the response. For general information, see OData query parameters.

Request headers

Name	Description
Authorization	Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of plannerPlanConfigurationLocalization objects in the response body.

Examples

Example 1: Get all localizations

The following example shows a request that gets all localized names for a plannerPlanConfiguration.

Request

The following is an example of a request.

GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations


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

var graphClient = new GraphServiceClient(requestAdapter);

var result = await graphClient.Solutions.BusinessScenarios["{businessScenario-id}"].Planner.PlanConfiguration.Localizations.GetAsync();

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 list --business-scenario-id {businessScenario-id}

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"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



localizations, err := graphClient.Solutions().BusinessScenarios().ByBusinessScenarioId("businessScenario-id").Planner().PlanConfiguration().Localizations().Get(context.Background(), 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();

PlannerPlanConfigurationLocalizationCollectionPage localizations = graphClient.solutions().businessScenarios("c5d514e6c6864911ac46c720affb6e4d").planner().planConfiguration().localizations()
	.buildRequest()
	.get();

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);

let localizations = await client.api('/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations')
	.version('beta')
	.get();

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);


$result = $graphServiceClient->solutions()->businessScenarios()->byBusinessScenarioId('businessScenario-id')->planner()->planConfiguration()->localizations()->get()->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

Get-MgBetaBusinessScenarioPlannerPlanConfigurationLocalization -BusinessScenarioId $businessScenarioId

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)


result = await graph_client.solutions.busine_scenarios.by_busine_scenario_id('businessScenario-id').planner.plan_configuration.localizations.get()

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

{
  "value": [
    {
      "@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"
          }
      ]
    },
    {
      "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization",
      "id": "pt-br",
      "languageTag": "pt-br",
      "planTitle": "Acompanhamento de pedidos",
      "buckets": [
          {
              "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization",
              "externalBucketId": "deliveryBucket",
              "name": "Entregas"
          },
          {
              "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization",
              "externalBucketId": "storePickupBucket",
              "name": "Retirada na loja"
          },
          {
              "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization",
              "externalBucketId": "specialOrdersBucket",
              "name": "Pedidos especiais"
          },
          {
              "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization",
              "externalBucketId": "returnProcessingBucket",
              "name": "Devoluções"
          }
      ]
    }
  ]
}

Example 2: Get localization for a specific language tag

The following example shows a request that gets all localized names for a plannerPlanConfiguration for a specific language.

Request

The following is an example of a request.

GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations?$filter=languageTag eq 'en-us'


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

var graphClient = new GraphServiceClient(requestAdapter);

var result = await graphClient.Solutions.BusinessScenarios["{businessScenario-id}"].Planner.PlanConfiguration.Localizations.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Filter = "languageTag eq 'en-us'";
});

Important

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 list --business-scenario-id {businessScenario-id} --filter "languageTag eq 'en-us'"

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"
	  graphsolutions "github.com/microsoftgraph/msgraph-beta-sdk-go/solutions"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



requestFilter := "languageTag eq 'en-us'"

requestParameters := &graphsolutions.SolutionsBusinessScenarioItemPlannerPlanConfigurationLocalizationsRequestBuilderGetQueryParameters{
	Filter: &requestFilter,
}
configuration := &graphsolutions.SolutionsBusinessScenarioItemPlannerPlanConfigurationLocalizationsRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

localizations, err := graphClient.Solutions().BusinessScenarios().ByBusinessScenarioId("businessScenario-id").Planner().PlanConfiguration().Localizations().Get(context.Background(), configuration)

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();

PlannerPlanConfigurationLocalizationCollectionPage localizations = graphClient.solutions().businessScenarios("c5d514e6c6864911ac46c720affb6e4d").planner().planConfiguration().localizations()
	.buildRequest()
	.filter("languageTag eq 'en-us'")
	.get();

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);

let localizations = await client.api('/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations')
	.version('beta')
	.filter('languageTag eq \'en-us\'')
	.get();

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);

$requestConfiguration = new LocalizationsRequestBuilderGetRequestConfiguration();
$queryParameters = LocalizationsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "languageTag eq 'en-us'";
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->solutions()->businessScenarios()->byBusinessScenarioId('businessScenario-id')->planner()->planConfiguration()->localizations()->get($requestConfiguration)->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

Get-MgBetaBusinessScenarioPlannerPlanConfigurationLocalization -BusinessScenarioId $businessScenarioId -Filter "languageTag eq 'en-us'"

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)

query_params = LocalizationsRequestBuilder.LocalizationsRequestBuilderGetQueryParameters(
		filter = "languageTag eq 'en-us'",
)

request_configuration = LocalizationsRequestBuilder.LocalizationsRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.solutions.busine_scenarios.by_busine_scenario_id('businessScenario-id').planner.plan_configuration.localizations.get(request_configuration = request_configuration)

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

{
  "value": [
    {
      "@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"
          }
      ]
    }
  ]
}

List plannerPlanConfigurationLocalizations

Permissions

HTTP request

Optional query parameters

Request headers

Request body

Response

Examples

Example 1: Get all localizations

Request

Response

Example 2: Get localization for a specific language tag

Request

Response

Feedback

Additional resources

Additional resources