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

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に使用できるクエリパラメータを示します。

パラメータ	説明
action	必須。クエリ結果に、指定したビジネスエンティティタイプのすべてのレコードを返します。 query に設定し、 filter パラメータを設定してこのパラメータを使用します。 filter パラメータを指定せずに使用すると、指定したビジネスエンティティタイプのすべてのレコードがクエリによって検索されます。例えば、次のクエリを使用すると、すべてのPersonビジネスエンティティレコードが検索されます。 Person?action=query
filter	必須。演算子で区切られた、フィールド値ペアのリストを指定します。有効な演算子はAND、IN、およびRangeです。例えば、次のクエリを使用すると、名がSTEVEで姓がSMITHのPersonレコードが検索されます。 Person?action=query&filter=firstName='STEVE' AND lastName='SMITH'
depth	返す子レコードレベルの数を指定します。例えば、以下のレベルを指定できます。 1. ルートレコードを返します。 2. ルートレコードと、その直接の子レコードを返します。 3. ルートレコード、直接の子レコード、および孫レコードを返します。例えば、次のクエリを使用すると、名がSTEVEのレコードが検索され、ルートレコードとその直接の子レコードに関する情報が返されます。 Person?action=query&filter=firstName='STEVE' AND lastName='SMITH'&depth=2
suppressLinks	API応答に親と子のリンクを含めるかどうかを示します。応答に親と子のリンクをいっさい含めない場合は、このパラメータをtrueに設定します。デフォルトはfalseです。例えば、次のクエリを使用すると、名がSTEVEのレコードが検索され、親と子のリンクが表示されない応答が返されます。 Person?action=query&filter=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=query&filter=firstName='STEVE' AND lastName='SMITH'
IN: フィルタパラメータのリストに含まれる値のいずれかを持つレコードが検索されます。; 例えば、次のクエリを使用すると、名がSTEVEまたはJOHNのレコードが検索されます。
Person?action=query&filter=firstName IN [STEVE,JOHN]
範囲: 指定した範囲内のレコードが検索されます。数値および日付のデータ型のフィールドに範囲を指定できます。; 整数データ型では、次の形式を使用します。

<business entity field name>=[fromValue,toValue]

範囲は、fromValueからtoValueです。fromValueがtoValueよりも小さいことを確認してください。; 例えば、次のクエリを使用すると、年齢グループが35から45のレコードが検索されます。
Person?action=query&filter=firstName IN [STEVE,JOHN] AND age=[35,45]; 日付データ型では、次の形式を使用します。
<business entity field name>=[fromDate,toDate]

範囲は、fromDateからtoDateです。; 例えば、次のクエリを使用すると、誕生日が2000年6月12日から2015年6月12日のレコードが検索されます。
Person?action=query&filter=birthDate=[2000-06-12T12:30:00Z,2015-06-12T12:30:00Z]
! =: 指定されたフィールド値または範囲に一致しないレコードを検索します。; 例えば、次のクエリを使用すると、名がADAM以外のレコードが検索されます。
Person?action=query&filter=firstName!='ADAM'

例えば、次のクエリを使用すると、名がADAM以外で、生年月日が2017年11月16日より前と2020年11月16日より後のレコードが検索されます
Person?action=query&filter=firstName!='ADAM' AND birthdate!=[2017-11-16T00:00:00,2020-11-16T00:00:00]
ワイルドカード: 完全な検索文字列の代わりに、テキストとアスタリスク（*）ワイルドカード演算子を使用してテキストパターンを指定できます。アスタリスクワイルドカード演算子を使用すると、目的のレコードが見つかる可能性が高くなります。アスタリスクワイルドカード演算子は、正確に一致するテキストがわからない場合や、類似テキストを検索する場合に便利です。; 次の表に、検索文字列の例とそれぞれの働きについて説明します。; クエリ文字列の例
クエリの動作

John*
John
で始まる値が含まれるレコードをクエリします。例えば、
Johnson
や
Johnny
が該当します。

Jo*n
Jo
で始まり
n
で終わるレコードをクエリします。例えば、
Johansson
や
Jordan
が該当します。

*
すべてのレコードを返します。

クエリ文字列の例	クエリの動作
John*	John で始まる値が含まれるレコードをクエリします。例えば、 Johnson や Johnny が該当します。
Jo*n	Jo で始まり n で終わるレコードをクエリします。例えば、 Johansson や Jordan が該当します。
*	すべてのレコードを返します。

SearchQuery

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal

Rename Saved Search

目次

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

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

クエリパラメータ

クエリパラメータ

演算子