目次

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

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

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

クエリパラメータ

クエリパラメータ

始める前に、[レコード履歴イベントの取得]APIを使用して、レコードに関連付けられている履歴イベントをリストします。返された結果から、履歴イベントIDとレコードIDをクエリパラメータとして使用します。
次の表にクエリパラメータを示します。
パラメータ
説明
eventID
必須。[レコード履歴イベントの取得]APIは、履歴イベントのイベントIDを返します。
recordStates
オプション。履歴イベントのリストで返されるレコードの状態。カンマ区切りのリストを指定します。
以下の値を使用できます。
  • ACTIVE
  • PENDING
  • DELETED
contentMetadata
オプション。履歴イベントのリストのメタデータ。カンマ区切りのリストを指定します。
以下の値を使用できます。
  • XREF
  • PENDING_XREF
  • DELETED_XREF
  • HISTORY
  • MATCH
  • BVT
  • TRUST
children
オプション。子ノード名のカンマ区切りリスト。指定した場合、応答には子ノード名が含まれます。
order
オプション。
フィールド名のカンマ区切りリスト。オプションでプレフィックス
+
または
-
を指定できます。プレフィックス
+
は結果を昇順でソートし、プレフィックス
-
は結果を降順でソートすることを指定します。デフォルトは
+
です。複数のパラメータを指定した場合、結果セットは、指定した最初のパラメータでまずソートされてから、次のパラメータでソートされます。
fields
オプション。ビジネスエンティティフィールドのカンマ区切りリスト。指定した場合、応答にはリストされたフィールドのみが含まれます。
filter
オプション。フィルタ式。
depth
オプション。返す子レベルの数。
recordsToReturn
オプション。返す行の数を指定します。
searchToken
オプション。前の要求で返された検索トークンを指定します。
returnTotal
オプション。
true
に設定すると、結果内のレコードの数が返されます。デフォルトは
false
です。
firstRecord
オプション。結果の最初の行を指定します。