Update businessScenario

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

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 business scenario based on its ID (primary key):

PATCH /solutions/businessScenarios/{businessScenarioId}

For a specific business scenario based on its unique name:

PATCH /solutions/businessScenarios(uniqueName='{uniqueName}')

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 are not included in the request body will maintain 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
displayName String Display name of the scenario. 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 200 OK response code and an updated businessScenario object in the response body.

Examples

Request

The following is an example of a request.

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

{
  "ownerAppIds": [
      "44109254-4b2b-7a33-76ee-c890a167b295", "13eb9d8b-1d63-4153-9417-3a69ab200a78"
  ]
}

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.businessScenario",
  "id": "c5d514e6c6864911ac46c720affb6e4d",
  "displayName": "Contoso Order Tracking",
  "uniqueName": "com.contoso.apps.ordertracking",
  "ownerAppIds": [
      "44109254-4b2b-7a33-76ee-c890a167b295", "13eb9d8b-1d63-4153-9417-3a69ab200a78"
  ]
}