ITメモ

ITのこと学習中

Business Central で簡単にAPI Endpointを作れる Data Braider

Data Braider」というBusiness Central のAPI Endpointを作成するBusiness Central のサードパーティ製アプリがあります。制作には MVPの Jeremy Vyska 氏、Stefan Maroń 氏などが関わっています。こちらのアプリが無料で利用可能と紹介されていたので、試してみました。詳しい情報は、data braider のパンフレット

GitHub - Spare-Brained-Community/SBI-DataBraider: Code Signing Repo for SBI Data Braider  を確認してみてください。

MS Marketplace の Data Braider画面

Data Braider

マイクロソフトのマーケットプレイスからBusiness Centralへインストール、または、Business Central から直接インストールします。

Business Central の Extension Management から Data Braider をインストール

BC で Data Braider インストール

Data Braider Setup より設定の確認が可能です。必要に応じて変更します。

Data Braider Setup page

Data Braider setup ページ

Setup Standard Endpoints より API の Endpoint を作成できます。標準的なページのAPIのEndpointは用意されています。

API Endpoints can be created from Create Endpoints page.

Create Endpoints ページ

試しに SPB-SALESORDERLINES と SPB-SALESORDERS の Create Data Braider Endpoints にチェックを入れて、Create Selected Endpoints をクリックして作成します。少し待つと、Sales Order Lines と Sales Orders の API Endpoint ができました。リストページに作成された一覧が表示され、詳細はカードページで確認できます。

Data Braider API Endpoints list page and card page

Data Braider API Endpoints リストページと詳細ページ

詳細ページでは、Read only設定など各種設定が可能です。プレビュー機能もあるので、出力されるデータの確認もできます。

Data Braider の Sales Order Lines API 出力例

Sales Order Lines API 出力例

API出力するフィールドの設定ができるので、Business Central の標準のAPIより出力項目を増やすのも簡単にできます。

The users can select fields for API

Endpoint Fields 追加・減少できる

Fields comparison in API json data

フィールド追加比較

他に親子関係を作成して、データをまとめて出力することもできます。Endpoint に出力に利用するテーブルを選択します。次にリレーションを追加します。最後に、出力するフィールドを追加します。リレーションの追加と出力フィールドの順番は関係ないと思います。

Add a table for additional information

テーブル追加

Create parent-child relationship

親子のリレーション作成

Select the fields to add the parent data

追加テーブルから表示するフィールド選択

これでプレビューすると、データが最後に追加されているのが確認できます。

Parent data and child data are displayed in one single json data.

関連データ(Customer)をSales Order Lines に追加

他にも、Postman Collection や Power BI Query 用に出力など機能があります。

 

マイクロソフト社の今後の方針がどのようになるかわかりませんが、OData v4リストの代わりにこのData Braider app を使えるかも。
Changes in 2027 release wave 1 (version 30.0)
Remove ability to expose a Microsoft page as an OData endpoint (removal)

Deprecated features in the platform - Clients, Server, and Database

Deprecated features in the platform - Clients, Server, and Database