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

10.4 HotFix 3
- 10.4 HotFix 2
- 10.4
- 10.3 HotFix 1
- 10.3
- 10.2 HotFix 2
- 10.2 HotFix 1
- 10.2

前へ次へ

クエリパラメータ

レコードの詳細をフィルタリングする場合、要求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で昇順にソートされ、次に有効開始日で降順にソートされて表示されます。
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" }

次のサンプルは、レコードの詳細をフィルタリングする方法を示しています。

GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person/123/Phone/SFA:456/PhoneUse?recordsToReturn=100&recordStates=ACTIVE,PENDING&contentMetadata=XREF

レコードの読み取り

UTCでの日付と時刻の形式

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal

Rename Saved Search

目次

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

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

クエリパラメータ

クエリパラメータ