Edit

businessScenario resource type

  • Article

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.

Represents a scenario that collects relevant data and configuration for a specific problem domain. For more details about business scenarios, see Business scenarios API overview.

Inherits from entity.

Note

Currently the business scenario API supports only Planner. The API allows app developers to define a configuration for a Planner plan to host scenario-specific tasks, and bring in custom data in each scenario-specific task.

Do you have a scenario that requires bringing in custom data as entities to another Microsoft 365 service? Suggest the feature or vote for existing feature requests.

Methods

Method Return type Description
List businessScenarios businessScenario collection Get a list of all businessScenario objects in an organization.
Create businessScenario businessScenario Create a new businessScenario object.
Get businessScenario businessScenario Read the properties and relationships of a businessScenario object.
Update businessScenario businessScenario Update the properties of a businessScenario object.
Delete businessScenario None Delete a businessScenario object. The deletion of a scenario causes all data associated with the scenario to be deleted.
Get businessScenarioPlanner businessScenarioPlanner Read the properties and relationships of a businessScenarioPlanner object.

Properties

Property Type Description
createdBy identitySet The identity of the user who created the scenario.
createdDateTime DateTimeOffset The date and time when the scenario was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
displayName String Display name of the scenario.
id String The unique identifier for the scenario. Inherited from entity.
lastModifiedBy identitySet The identity of the user who last modified the scenario.
lastModifiedDateTime DateTimeOffset The date and time when the scenario was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
ownerAppIds String collection Identifiers of applications that are authorized to work with this scenario.
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.

Relationships

Relationship Type Description
planner businessScenarioPlanner Planner content related to the scenario.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.businessScenario",
  "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
  "createdDateTime": "String (timestamp)",
  "displayName": "String",
  "id": "String (identifier)",
  "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
  "lastModifiedDateTime": "String (timestamp)",
  "ownerAppIds": ["String"],
  "uniqueName": "String"
}