目次

Search

  1. はじめに
  2. ビジネスエンティティサービスについて
  3. Enterprise Java Beanビジネスエンティティサービス呼び出し
  4. Representational State Transferビジネスエンティティサービス呼び出し
  5. Simple Object Access Protocolビジネスエンティティサービス呼び出し
  6. 相互参照レコードおよびBVT計算用のサービス
  7. 企業リンケージサービスのサポート
  8. ビジネスエンティティデータをクレンジング、分析、変換するための外部呼び出し
  9. REST APIを使用したビジネスエンティティレコードの追加

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

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

クエリパラメータ

クエリパラメータ

ビジネスエンティティのIDは、必須パラメータです。このAPIは、ビジネスエンティティIDを使用して、関連するすべての履歴イベントを検索します。
次の表にクエリパラメータを示します。
パラメータ
説明
startDateと
endDate
オプション。データの取得対象となる日付範囲。日付範囲を指定すると、応答にはその範囲内のイベントのみが含まれます。
granularity
オプション。履歴イベントをグループ化する詳細のレベル。指定すると、応答で履歴イベントがグループ化されます。指定しないと、応答で履歴イベントはグループ化されません。
以下の値を使用します。
  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • AUTO
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
オプション。結果の最初の行を指定します。
changeType
オプション。結果で返される変更のタイプを指定します。カンマ区切りのリストを指定します。
以下の値を使用できます。
  • BO
  • XREF
  • BVT
  • MERGE
  • MERGE_AS_SOURCE
  • MERGE_AS_TARGET
  • UNMERGE_AS_SOURCE
  • UNMERGE_AS_TARGET