businessScenarioPlanner: getPlan

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 information about the plannerPlan mapped to a given target. If a plannerPlan doesn't exist for the specified target at the time of the request, a new plan will be created for the businessScenario.

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

HTTP request

POST /solutions/businessScenarios/{businessScenarioId}/planner/getPlan

Request headers

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

Request body

In the request body, supply a JSON representation of the parameters.

The following table shows the parameter that can be used with this action.

Parameter	Type	Description
target	businessScenarioTaskTargetBase	Target for which to get the plan information.

Response

If successful, this action returns a 200 OK response code and a businessScenarioPlanReference object in the response body.

Examples

Request

The following is an example of a request.

HTTP

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

{
  "target": {
      "@odata.type": "microsoft.graph.businessScenarioGroupTarget",
      "taskTargetKind": "group",
      "groupId": "7a339254-4b2b-4410-b295-c890a16776ee"
  }
}

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var target = new BusinessScenarioGroupTarget
{
	TaskTargetKind = PlannerTaskTargetKind.Group,
	GroupId = "7a339254-4b2b-4410-b295-c890a16776ee"
};

await graphClient.Solutions.BusinessScenarios["{businessScenario-id}"].Planner
	.GetPlan(target)
	.Request()
	.PostAsync();

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 businessScenarioPlanReference = {
  target: {
      '@odata.type': 'microsoft.graph.businessScenarioGroupTarget',
      taskTargetKind: 'group',
      groupId: '7a339254-4b2b-4410-b295-c890a16776ee'
  }
};

await client.api('/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/getPlan')
	.version('beta')
	.post(businessScenarioPlanReference);

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

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

BusinessScenarioGroupTarget target = new BusinessScenarioGroupTarget();
target.taskTargetKind = PlannerTaskTargetKind.GROUP;
target.groupId = "7a339254-4b2b-4410-b295-c890a16776ee";

graphClient.solutions().businessScenarios("c5d514e6c6864911ac46c720affb6e4d").planner()
	.getPlan(BusinessScenarioPlannerGetPlanParameterSet
		.newBuilder()
		.withTarget(target)
		.build())
	.buildRequest()
	.post();

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

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := graphmodels.NewGetPlanPostRequestBody()
target := graphmodels.NewBusinessScenarioTaskTargetBase()
taskTargetKind := graphmodels.GROUP_PLANNERTASKTARGETKIND 
target.SetTaskTargetKind(&taskTargetKind) 
additionalData := map[string]interface{}{
	"groupId" : "7a339254-4b2b-4410-b295-c890a16776ee", 
}
target.SetAdditionalData(additionalData)
requestBody.SetTarget(target)

result, err := graphClient.Solutions().BusinessScenariosById("businessScenario-id").Planner().GetPlan().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.

PowerShell

Import-Module Microsoft.Graph.Bookings

$params = @{
	Target = @{
		"@odata.type" = "microsoft.graph.businessScenarioGroupTarget"
		TaskTargetKind = "group"
		GroupId = "7a339254-4b2b-4410-b295-c890a16776ee"
	}
}

Get-MgBusinessScenarioPlannerPlan -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.

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new GetPlanPostRequestBody();
$target = new BusinessScenarioTaskTargetBase();
$target->set@odatatype('microsoft.graph.businessScenarioGroupTarget');

$target->setTaskTargetKind(new PlannerTaskTargetKind('group'));

$additionalData = [
'groupId' => '7a339254-4b2b-4410-b295-c890a16776ee', 
];
$target->setAdditionalData($additionalData);



$requestBody->setTarget($target);


$requestResult = $graphServiceClient->solutions()->businessScenariosById('businessScenario-id')->planner()->getPlan()->post($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.

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.businessScenarioPlanReference",
  "id": "pmc1rS1Io0C3rXQhyXIsNmUAOeIi",
  "title": "Order Tracking"
}