目次

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を使用したレポートの管理

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

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

クエリパラメータ

クエリパラメータ

fuzzyFilter
パラメータを使用して、クエリするフィールド値を指定します。
fuzzyFilter
パラメータを
action
パラメータと一緒に使用します。
次の表に、URLに使用できるクエリパラメータを示します。
パラメータ
説明
action
必須。指定したビジネスエンティティに一致するレコードを返します。
match
に設定し、
fuzzyFilter
パラメータを設定してこのパラメータを使用します。
例えば、次のクエリを使用すると、名がSTEVEの個人が検索されます。
Person?action=match&fuzzyFilter=STEVE
fuzzyFilter
必須。特定のビジネスエンティティタイプのレコードに対するクエリで使用する、フィールド名とフィールド値のペアの、カンマ区切りリストを指定します。
例えば、次のクエリを使用すると、名がSTEVEで住所がTorontoのレコードが検索されます。
Person?action=match&fuzzyFilter=firstName=STEVE,Address.Address.City=TORONTO
matchRuleSet
一致したレコードを識別するために使用する、一致ルールセットを指定します。
特定の一致ルールセットがない場合は、[NONE]を指定します。自動および手動マージの一致ルールが使用されます。
filter
あいまい検索の結果のフィルタに使用するフィールド値を指定します。
例えば、次のクエリを使用すると、Torontoに住んでいて名がSTEVEのレコードが検索されます。
Person?action=match&fuzzyFilter=firstName='STEVE',lastName="SMITH'&filter=city=Toronto
depth
返す子レコードレベルの数を指定します。例えば、以下のレベルを指定できます。
  • 1. ルートレコードを返します。
  • 2. ルートレコードと、その直接の子レコードを返します。
  • 3. ルートレコード、直接の子レコード、および孫レコードを返します。
例えば、次のクエリを使用すると、名がSTEVEのレコードが検索され、ルートレコードとその直接の子レコードに関する情報が返されます。
Person?action=match&fuzzyFilter=firstName='STEVE'&filter=city=Toronto
suppressLinks
API応答に親と子のリンクを含めるかどうかを示します。応答に親と子のリンクをいっさい含めない場合は、このパラメータをtrueに設定します。デフォルトはfalseです。
例えば、次のクエリを使用すると、名がSTEVEのレコードが検索され、親と子のリンクが表示されない応答が返されます。
Person?action=match&fuzzyFilter=firstName='STEVE'&suppressLinks=true
readSystemFields
結果でシステムフィールドを返すかどうかを示します。デフォルトはfalseです。
fields
クエリ結果に表示するフィールドを指定します。
outputView
クエリ結果を表示するために使用するビジネスエンティティビューを指定します。クエリ結果のビジネスエンティティビューを設定する場合は、クエリ結果に表示するフィールドを含めます。
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" }
フィルタパラメータ内で次の演算子を使用できます。
AND
フィルタパラメータのリストに含まれるすべてのフィールド値を持つレコードが検索されます。
例えば、次のクエリを使用すると、名がSTEVEで姓がSMITHのレコードが検索されます。
Person?action=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=city=Toronto AND gender=Male
IN
フィルタパラメータのリストに含まれる値のいずれかを持つレコードが検索されます。
例えば、次のクエリを使用すると、TorontoまたはOttawaの都市に住んでいて、名がSTEVEまたは姓がJOHNのレコードが検索されます。
Person?action=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=city in [Toronto,Ottawa]
範囲
指定した範囲内のレコードが検索されます。数値および日付のデータ型のフィールドに範囲を指定できます。
整数データ型では、次の形式を使用します。
<business entity field name>=[fromValue,toValue]
範囲は、fromValueからtoValueです。fromValueがtoValueよりも小さいことを確認してください。
例えば、次のクエリを使用すると、年齢グループが35から45のレコードが検索されます。
Person?action=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=age=[35,45]
日付データ型では、次の形式を使用します。
<business entity field name>=[fromDate,toDate]
範囲は、fromDateからtoDateです。
例えば、次のクエリを使用すると、誕生日が2000年6月12日から2015年6月12日のレコードが検索されます。
Person?action=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=birthDate=[2000-06-12T12:30:00Z,2015-06-12T12:30:00Z]