目次

Search

  1. はじめに
  2. ビジネスエンティティサービスについて
  3. EJBビジネスエンティティサービス呼び出し
  4. REST ビジネスエンティティサービス呼び出し
  5. Data DirectorのREST API
  6. SOAPビジネスエンティティサービス呼び出し
  7. 相互参照レコードとBVT計算サービス
  8. 企業リンケージサービスのサポート
  9. データをクレンジング、分析、変換するための外部呼び出し
  10. 付録 A: REST APIを使用したレコードの追加
  11. 付録 B: REST APIを使用したファイルのアップロード
  12. 付録 C: REST APIを使用したレポートの管理

ビジネスエンティティサービスガイド

ビジネスエンティティサービスガイド

クエリパラメータ

クエリパラメータ

クエリパラメータを要求URLに追加して、結果をフィルタリングできます。
次の表にクエリパラメータを示します。
パラメータ
説明
suppressLinks
API応答に親と子のリンクを含めるかどうかを示します。応答に親と子のリンクをいっさい含めない場合は、このパラメータをtrueに設定します。デフォルトはfalseです。
例えば、
Person/1242?depth=10&suppressLinks=true
クエリでは、レコードの詳細が最大10の子レベルまで表示され、応答に親と子のリンクは含まれません。
order
ルックアップ値を昇順または降順で表示するのに使用します。
+
をプレフィックスとして使用すると昇順、
-
をプレフィックスとして使用すると降順でソートされます。デフォルトでは、プレフィックスを指定しない場合、結果セットは昇順でソートされます。
例えば、
LUNamePrefix?action=list&order=-namePrefixDisp
クエリでは、名前のプレフィックスが、プレフィックスの表示名で降順にソートされて表示されます。
resolveLookup
指定されたビジネスエンティティのルックアップフィールド全体を取得します。パラメータをtrueに設定して、ルックアップフィールドをロードし、応答に含めます。デフォルトはfalseです。
例えば、addressTypeフィールドは、Personビジネスエンティティの子レベルのルックアップフィールドです。
resolveLookupパラメータがfalseに設定されている場合、次のREST API応答を受信する可能性があります。
{ "label": "LU Address Type", "addressType": "BILL" }
resolveLookupsパラメータがtrueに設定されている場合、REST API応答には追加の詳細が含まれ、次のREST API応答を受信する可能性があります。
{ "label": "LU Address Type", "addressType": "BILL", "addressTypeDisp": "BILLING" }