Create businessScenario

Article
10/27/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.

Create a new businessScenario 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

POST /solutions/businessScenarios

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 businessScenario object.

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

Property	Type	Description
displayName	String	Display name of the scenario. Required.
uniqueName	String	Unique name of the scenario. To avoid conflicts, the recommended value for the unique name is a reverse domain name format, owned by the author of the scenario. For example, a scenario authored by Contoso.com would have a unique name that starts with `com.contoso`. Required.
ownerAppIds	String collection	Identifiers of applications that are authorized to work with this scenario. The application that creates the scenario will be automatically added to the list. Optional.

Response

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

Examples

Request

The following example shows a request.

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

{
  "@odata.type": "#microsoft.graph.businessScenario",
  "displayName": "Contoso Order Tracking",
  "uniqueName": "com.contoso.apps.ordertracking"
}


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

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

var requestBody = new BusinessScenario
{
	OdataType = "#microsoft.graph.businessScenario",
	DisplayName = "Contoso Order Tracking",
	UniqueName = "com.contoso.apps.ordertracking",
};

// 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.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.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta solutions business-scenarios create --body '{\
  "@odata.type": "#microsoft.graph.businessScenario",\
  "displayName": "Contoso Order Tracking",\
  "uniqueName": "com.contoso.apps.ordertracking"\
}\
'

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.NewBusinessScenario()
displayName := "Contoso Order Tracking"
requestBody.SetDisplayName(&displayName) 
uniqueName := "com.contoso.apps.ordertracking"
requestBody.SetUniqueName(&uniqueName) 

businessScenarios, err := graphClient.Solutions().BusinessScenarios().Post(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.


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

BusinessScenario businessScenario = new BusinessScenario();
businessScenario.setOdataType("#microsoft.graph.businessScenario");
businessScenario.setDisplayName("Contoso Order Tracking");
businessScenario.setUniqueName("com.contoso.apps.ordertracking");
BusinessScenario result = graphClient.solutions().businessScenarios().post(businessScenario);

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 businessScenario = {
  '@odata.type': '#microsoft.graph.businessScenario',
  displayName: 'Contoso Order Tracking',
  uniqueName: 'com.contoso.apps.ordertracking'
};

await client.api('/solutions/businessScenarios')
	.version('beta')
	.post(businessScenario);

Important

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


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\BusinessScenario;


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

$requestBody = new BusinessScenario();
$requestBody->setOdataType('#microsoft.graph.businessScenario');
$requestBody->setDisplayName('Contoso Order Tracking');
$requestBody->setUniqueName('com.contoso.apps.ordertracking');

$result = $graphServiceClient->solutions()->businessScenarios()->post($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.businessScenario"
	displayName = "Contoso Order Tracking"
	uniqueName = "com.contoso.apps.ordertracking"
}

New-MgBetaBusinessScenario -BodyParameter $params

Important

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


from msgraph import GraphServiceClient
from msgraph.generated.models.business_scenario import BusinessScenario

graph_client = GraphServiceClient(credentials, scopes)

request_body = BusinessScenario(
	odata_type = "#microsoft.graph.businessScenario",
	display_name = "Contoso Order Tracking",
	unique_name = "com.contoso.apps.ordertracking",
)

result = await graph_client.solutions.business_scenarios.post(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 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.businessScenario",
  "id": "c5d514e6c6864911ac46c720affb6e4d",
  "displayName": "Contoso Order Tracking",
  "uniqueName": "com.contoso.apps.ordertracking",
  "ownerAppIds": [
      "44109254-4b2b-7a33-76ee-c890a167b295"
  ]
}

Create businessScenario

Permissions

HTTP request

Request headers

Request body

Response

Examples

Request

Response

Feedback

Feedback

Additional resources