生成ページの dataApi リファレンス

自然言語を使用してページを生成すると、AI によって TypeScript に React ページが作成されます。 生成されたページには、適切なコンポーネントを選択して最適なレイアウトを決定することで、フロントエンド ユーザー エクスペリエンスと、対応するビジネス ロジックの両方が含まれます。

生成されたコードを表示および編集して、出力を絞り込むことができます。 データ操作では、次のカテゴリにグループ化されたパブリック メソッドを公開する dataApi オブジェクトを使用します。

Category Description
Dataverse テーブル メソッド Dataverse テーブル行とクエリ選択列を作成、取得、更新、および削除します。
コネクタ メソッド ページにバインドされた Power Platform コネクタによって公開されるデータを操作します。
Dataverse 操作メソッド ページにバインドされた Dataverse カスタム API をアクションまたは関数として呼び出します。
Page メソッド ページがダイアログとして使用されるときに値を返すなど、生成ページ自体を制御します。

コネクタ メソッドとアクション メソッドと関数メソッドは、 dataApi コントラクトの省略可能なメンバーです。 一部のホストでは実装されないため、呼び出す前にメソッドが存在することを常に確認してください (たとえば、 if (dataApi.executeAction) { ... })。 存在するメソッドは、ページにコネクタまたは Dataverse カスタム API がバインドされていること、または現在のユーザーに対してカスタム API が有効または許可されていることを意味するものではありません。 使用できない機能とカスタム API エラーは、成功を想定するのではなく、明示的に処理します。

Dataverse テーブル メソッド

dataApi オブジェクトの Dataverse テーブル メソッドを使用して、Dataverse テーブル行の作成、取得、更新、削除、およびクエリ選択列を作成します。

メソッド Description
createRow 指定したテーブルに新しい行を作成します。
deleteRow 指定したテーブルから行を削除します。
getChoices 指定した選択肢の列名の選択肢を取得します。
queryTable 指定したオプションを使用してテーブルを照会します。
retrieveRow 指定したオプションを持つ指定したテーブルから行を取得します。
updateRow 指定したテーブル内の既存の行を更新します。

コネクタ メソッド

ページにバインドされた Power Platform コネクタによって公開されるデータを操作するには、 dataApi オブジェクトのコネクタ メソッドを使用します。

メソッド Description
createConnectorRow 指定したコネクタ テーブルに新しい行を作成します。
deleteConnectorRow 指定したコネクタ テーブルから行を削除します。
executeConnectorOperation REST (操作キー付き) コネクタによって公開される名前付き操作 (Office 365 ユーザーなど) を呼び出します。
getConnectorSwagger コネクタの Swagger (OpenAPI) 定義を取得します。
getConnectorTableSchema コネクタによって公開されるテーブル (エンティティまたはリストとも呼ばれます) のスキーマを取得します。
listConnectorDatasets コネクタで使用できるデータセットを一覧表示します。
listConnectorOperations REST (操作キー付き) コネクタによって公開される操作を一覧表示します。
listConnectorTables 指定したコネクタ データセットで使用できるテーブルを一覧表示します。
queryConnectorTable 指定したオプションを使用して、コネクタによって公開されるテーブルに対してクエリを実行します。
retrieveConnectorRow 指定したコネクタ テーブルから 1 行を取得します。
updateConnectorRow 指定したコネクタ テーブル内の既存の行を更新します。

Dataverse アクションと関数メソッド

dataApi オブジェクトのアクション メソッドと関数メソッドを使用して、ページにバインドされた Dataverse カスタム API を呼び出します。

メソッド Description
executeAction ページにバインドされた Dataverse カスタム API をアクションとして呼び出します。
executeFunction ページにバインドされた Dataverse カスタム API を関数として呼び出します。
listBoundActions ページにバインドされた Dataverse カスタム API (アクションと関数) を一覧表示します。

Page メソッド

dataApi オブジェクトのページ メソッドを使用して、ページがダイアログとして使用されるときに値を返すなど、生成ページ自体を制御します。

メソッド Description
setPageOutput 生成ページ ダイアログが閉じたときに呼び出し元スクリプトに返される値を設定します。