ビジネス・オブジェクトのリソースAPIおよびエンドポイントへのアクセス
ビジネス・オブジェクトごとに、Endpointsタブに、コードでコールできるエンドポイントに関する情報が表示されます。
リソースAPI
- 「メタデータ」 URLを使用して、
/describeエンドポイントを使用してビジネス・オブジェクトに関するメタデータを取得します。 - 「データ」 URLを使用して、CRUD操作を通じてビジネス・オブジェクト・データを変更します。
アプリケーションの各フェーズで正しいURLを使用することが重要です: 開発、ステージング、またはライブ。 開発URLは、アプリの開発フェーズでのみ使用され、通常は次の形式になります:
https://{host-name}/ic/builder/design/{app-name}/{app-version}/
このURLは、アプリのデザインタイム・バージョンへのポインタ(パスの/ic/builder/design/で示されます)で、アプリのプレビューにすぎません。 他のアプリやツールからあなたのアプリにアクセスできるようにすることは意図されていません。 たとえば、開発メタデータURLをコピーし、Postmanと同様のREST APIツールで使用して、開発中にメタデータURLをテストできます。
アプリケーションがステージングされると、URLはhttps://{host-name}/ic/builder/rt/{app-name}/{app-version}/に変わります。/ic/builder/rt/はアプリケーションのランタイム・バージョンを示します。 このURLはステージングされたアプリケーションを指し示しており、他のアプリケーションやツールから使用できます。
アプリケーションが公開されると、Visual Builderによって、アプリケーションの永続URL (https://{host-name}/ic/builder/rt/{app-name}/live/など)が生成されます。ここで、liveは、アプリケーションが現在稼働中であることを示す{app-version}に置換されます。
リソース・キャッシュ制御
「リソース・キャッシュ制御」ノードには、ビジネス・オブジェクト・データの格納に使用されるキャッシュ戦略が表示されます。 「ビジネス・オブジェクトのデータ・キャッシュの制御」を参照してください。エンドポイント
「エンドポイント」ノードには、ビジネス・オブジェクトのエンドポイントが表形式で表示されます。 表示には、HTTPメソッド、エンドポイントURI、コードで使用できるエンドポイント名、およびエンドポイントの説明が含まれます。 ページ上部のフィルタ・フィールドで、エンドポイントのサブセットを表示できます。
ビジネス・オブジェクトごとに、次の5つのデフォルト・エンドポイントが作成されます:
- 1つまたはすべてのビジネス・オブジェクト・インスタンスを検索するための2つの
GETエンドポイント - ビジネス・オブジェクト・インスタンスを作成するための
POSTエンドポイント - ビジネス・オブジェクト・インスタンスを更新するための
PATCHエンドポイント - ビジネス・オブジェクト・インスタンスを削除する場合は、
DELETEエンドポイント
ビジネス・オブジェクトが他のビジネス・オブジェクトを参照する場合、それらのビジネス・オブジェクトの取得、作成、削除および更新を可能にするエンドポイントも提供されます。 各ビジネス・オブジェクトに対して公開されるエンドポイントは、リソース・エディタで追加または削除することで制御できます(「公開されたエンドポイントの追加または削除」を参照)。
リスト内のエンドポイントをクリックすると、エンドポイントの設定やリクエストで送信されたヘッダーの詳細など、エンドポイントの詳細を表示できます。 詳細は読取り専用モードで表示されますが、「テスト」タブを使用すると、指定したパラメータ値で送信されたリクエストに対するレスポンスを確認できます。
「図bo-endpoints-details.pngの説明」