目次

Search

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

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

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

クエリパラメータ

クエリパラメータ

レコードの詳細をフィルタリングする場合、要求URLにクエリパラメータを付け加えることができます。
次の表にクエリパラメータを示します。
パラメータ
説明
depth
返す子レベルの数。ルートノードとその直接の子を返すには2を指定し、ルートノード、直接の子、および孫を返すには3を指定します。デフォルトは1です。
effectiveDate
データの取得対象となる日付。
readSystemFields
結果でシステムフィールドを返すかどうかを示します。デフォルトはfalseです。
recordStates
レコードの状態。カンマ区切りの状態リストを指定します。サポートされるレコードの状態は、ACTIVE、PENDING、およびDELETEDです。デフォルトはACTIVEです。
contentMetadata
レコードのメタデータ。カンマ区切りのリストを指定します。例えば、「XREF, PENDING_XREF, DELETED_XREF, HISTORY, XREF_HISTORY, and MATCH」のように指定します。
MATCHを選択すると、応答には_MTCHテーブルから取得した一致するレコードが含まれます。
historyDate
履歴データの取得対象となる日付。応答には、_HISTテーブルから取得した、指定した日付のビジネスエンティティデータが含まれます。
historyDateをcontentMetadataパラメータとともに使用して、履歴メタデータを取得できます。contentMetadataはXREF、BVT、またはTRUSTに設定します。
  • XREF。応答には、_HXRFテーブルからの履歴相互参照データが含まれます。
  • BVT。応答には、_HCTLテーブルからの履歴ベストバージョンオブトゥルースが含まれます。
  • TRUST。応答には、_HCTLおよび_HVXRテーブルからの履歴信頼設定が含まれます。
children
子ノードの名前またはパスのカンマ区切りリスト。
suppressLinks
API応答に親と子のリンクを含めるかどうかを示します。応答に親と子のリンクをいっさい含めない場合は、このパラメータをtrueに設定します。デフォルトはfalseです。
例えば、
Person/1242?depth=10&suppressLinks=true
クエリでは、レコードの詳細が最大10の子レベルまで表示され、応答に親と子のリンクは含まれません。
order
フィールド名のカンマ区切りリスト。オプションでプレフィックス
+
または
-
を指定できます。プレフィックス
+
は結果を昇順でソートし、プレフィックス
-
は結果を降順でソートすることを指定します。デフォルトは
+
です。複数のパラメータを指定した場合、結果セットは、指定した最初のパラメータでまずソートされてから、次のパラメータでソートされます。
例えば、
Person/1242/Names?order=-name
クエリでは、結果は名前の降順で表示されます。
Person/1242/BillAddresses?order=rowidObject,-effStartDate
クエリでは、請求先住所が行IDで昇順にソートされ、次に有効開始日で降順にソートされて表示されます。
次のサンプルは、レコードの詳細をフィルタリングする方法を示しています。
GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person/123/Phone/SFA:456/PhoneUse?recordsToReturn=100&recordStates=ACTIVE,PENDING&contentMetadata=XREF