Microsoft Graph でビジネス シナリオ API を使用する (プレビュー)

  • [アーティクル]

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

ビジネス シナリオ API を使用すると、Microsoft Graph へのデータの統合を構成および管理するビジネス シナリオの作成と管理が可能になります。

ビジネス シナリオの構造

ビジネス シナリオは、 businessScenario エンティティによって表されます。 businessScenario リソースは、シナリオに関する一般的な情報、そのシナリオを使用するアプリ、およびアプリがシナリオをサポートするために管理できるエンティティの構成を指定します。 アプリは、逆引きドメイン名形式を使用して、uniqueName プロパティによって businessScenario のインスタンスを識別できます。

ビジネス シナリオで使用できるエンティティ

ビジネス シナリオ API は、Microsoft Graph サービスが顧客に固有のサービス固有のシナリオをサポートするように拡張できるように設計されています。

現在、Plannerは API を拡張しています。 API では、businessScenarioTask エンティティ内のPlannerのカスタム シナリオ データがサポートされています。

注:

カスタム データをエンティティとして別の Microsoft 365 サービスに取り込む必要があるシナリオはありますか? 機能を提案するか、既存の機能要求に投票します。

ビジネス シナリオの作成

ビジネス シナリオは、委任されたアクセス許可 BusinessScenarioConfig.ReadWrite.OwnedByを使用してアプリケーションによって作成できます。 ビジネス シナリオを作成するには、表示名と一意の名前を指定する必要があります。 独立したシナリオ間の競合を防ぐために、一意の名前は逆引き DNS 形式にする必要があります。 逆引き DNS 形式は、シナリオ作成者が所有するドメイン名を受け取り、逆引きします。 たとえば、所有する開発者がシナリオを作成する apps.contoso.com 場合、シナリオの一意の名前は で com.contoso.apps始まる必要があります。 その後、さらにセグメントを追加して、シナリオまたはシナリオのグループを区別できます。たとえば、 com.contoso.apps.customerSupport.ticketManagementです。 シナリオの一意の名前は、テナントにデプロイされる他のすべてのシナリオとは異なる必要があります。

詳細については、「 BusinessScenario の作成」を参照してください。

エンティティの動作の構成

ビジネス シナリオでサポートされる各サービスは、シナリオの構成を提供します。 アプリケーションには、これらの構成にアクセスするためのアクセス許可とBusinessScenarioConfig.ReadWrite.OwnedBy、それらを変更できるアクセス許可が必要BusinessScenarioConfig.Read.OwnedByです。 各構成は、サービスに固有です。 詳細については、次のサービス固有のトピックを参照してください。

ビジネス シナリオのデータの作成と管理

ビジネス シナリオでサポートされる各サービスは、シナリオ内のデータにアクセスできます。 シナリオでデータを操作するには、アプリケーションを所有者として一覧表示する必要があります。 また、アプリケーションには、データを BusinessScenarioData.Read.OwnedBy 読み取ることができるアクセス許可と BusinessScenarioData.ReadWrite.OwnedBy 、新しいデータを作成したり、以前に作成したデータを変更したりするためのアクセス許可も必要です。 詳細については、次のサービス固有のトピックを参照してください。

ビジネス シナリオの削除

ビジネス シナリオを所有するアプリケーションは、アクセス許可がある場合にシナリオを BusinessScenarioConfig.ReadWrite.OwnedBy 削除できます。 シナリオを削除すると、シナリオに関連付けられているすべてのデータも削除されます。

詳細については、「 BusinessScenario の削除」を参照してください。

一般的なユース ケース

ユース ケース REST リソース 関連項目
ビジネス シナリオの作成、読み取り、更新、削除 businessScenario ビジネスの方法Scenario
Plannerのビジネス シナリオを構成する plannerPlanConfigurationplannerTaskConfiguration plannerTaskConfiguration の plannerPlanConfigurationメソッドのメソッド
Plannerでのビジネス シナリオ タスクの作成、読み取り、更新、削除 businessScenarioTask businessScenarioTask

次の手順

ビジネス シナリオ API を使用すると、アプリは、実際の作業ビジネス プロセスを Microsoft Graph 上の Microsoft 365 サービスとモデル化して統合できます。 詳細情報

  • 特定のシナリオに役立つ、メソッドとリソースのプロパティを詳しく調べます。
  • Graph エクスプローラーで API をお試しください。