Search

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

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

10.3

前へ次へ

クエリパラメータ

クエリパラメータ

qまたはfqクエリパラメータは、検索の文字列値を指定するために使用します。qクエリパラメータとfqクエリパラメータは相互に排他的です。fqクエリパラメータは、フィールド検索に使用します。複数の条件がある場合は、AND論理演算子を使用します。

次の表に、URLに使用できるパラメータを示します。

パラメータ	説明
q	文字列値または検索用語を指定します。このクエリでは、レコード内の検索用語の出現箇所が検索されます。基本検索で使用します。例えば、 Person?q=STEVE クエリでは、STEVEという用語のあるレコードが検索されます。 2つ以上の語句を一緒に検索するには、二重引用符にそれらの語句を含めます。検索結果に特定の語句が含まれるようにするには、各語句の前に文字「+」を入れます。フィールド値にスペースが含まれている場合、フィールド値を一重引用符で囲みます。 WILLIAM JOHN LAWSONと完全に一致するものを検索するには、次のクエリを使用します。 Person?q="WILLIAM JOHN LAWSON" WILLIAM、JOHN、またはLAWSONを検索するには、次のクエリを使用します。 Person?q=WILLIAM JOHN LAWSON WILLIAM、JOHN、およびLAWSONを検索するには、次のクエリを使用します。 Person?q=WILLIAM JOHN LAWSON&queryOperator=AND
fq	特定のフィールドの文字列値または検索用語を指定します。このクエリでは、レコードの特定部分の用語のみが検索されます。インデックス付きフィールドに基づいて検索対象を絞り込む場合に使用します。例えば、 Person?fq=displayname=STEVE クエリでは、表示名がSTEVEのレコードが検索されます。
ファセット	検索結果のグループ化の基準となるファセットまたはカテゴリとして扱われるフィールドを指定します。検索可能フィールドのみを指定します。qおよびfqパラメータとともに使用します。構文は、 &facets=FieldName1,FieldName2,FieldNameN です。例えば、 Person?q=STEVE&facets=department クエリでは、表示名がSTEVEの人物が検索され、検索結果が部門でグループ化されます。この検索では、表示名がSTEVEの人物のレコードが表示され、これらのレコードが部門でグループ化されます。
フィルタ	検索結果を絞り込むことができるフィールドを指定します。フィルタ可能フィールドのみを指定します。qおよびfqパラメータとともに使用します。例えば、 Person?fq=STEVE&filters=birthdate='1980-11-27T08:00:00Z' クエリでは、表示名がSTEVEの人物が検索され、検索結果が誕生日でフィルタリングされます。この検索では、表示名がSTEVEで誕生日が1980年11月27日の人物のレコードが表示されます。日付は、一重引用符で囲んで指定します。
depth	返す子レベルの数を指定します。ルートノードとその直接の子を返すには2を指定し、ルートノード、直接の子、および孫を返すには3を指定します。ルールノードのみを返すには、1を指定します。デフォルトでは、depthは指定されません。 depthを指定しないと、ルートノードと検索条件と一致する子のみが検索結果として返されます。例えば、 Person?q=STEVE&depth=2 クエリでは、STEVEという用語のあるレコードが検索され、ルートレコードとその直接の子に関する情報が返されます。
queryOperator	検索用語内の文字列のいずれかまたはそのすべてを検索するかどうかを指定します。パラメータは次のいずれかの値を使用します。 OR 。 f または fq パラメータに表示されたいずれかの文字列を検索します。 AND 。 f または fq パラメータに表示されたすべての文字列を検索します。このパラメータを指定しない場合、デフォルトは OR です。例えば、 Person?q=WILLIAM JOHN LAWSON&queryOperator=AND クエリは、WILLIAM、JOHN、およびLAWSONが含まれるレコードを検索します。
suppressLinks	API応答に親と子のリンクを含めるかどうかを示します。応答に親と子のリンクをいっさい含めない場合は、このパラメータをtrueに設定します。デフォルトはfalseです。例えば、 Person?q=STEVE&suppressLinks=true クエリは、用語STEVEが含まれているレコードを検索して、親と子のリンクを含まない応答を返します。
readSystemFields	結果でシステムフィールドを返すかどうかを示します。デフォルトはfalseです。
order	フィールド名のカンマ区切りリスト。オプションでプレフィックス + または - を指定できます。プレフィックス + は結果を昇順でソートし、プレフィックス - は結果を降順でソートすることを指定します。デフォルトは + です。子フィールドを使用して結果をソートする場合は、フィールドの完全な名前を使用します。例えば、 BillAddresses.Address.cityName を使用します。複数のパラメータを指定した場合、結果セットは、指定した最初のパラメータでまずソートされてから、次のパラメータでソートされます。例えば、 Person?order=displayName,-BillAddresses.Address.cityName クエリは、表示名で昇順に結果をソートしてから、都市名で降順にソートします。
maxRecordsToSort	ソートする検索結果の最大数。デフォルトは1000です。

filters
パラメータでの範囲の指定
:

filtersパラメータを使用して、特定の範囲内に検索結果を絞り込むことができます。数値データ型および日付データ型のフィルタ可能フィールドの範囲を指定できます。

整数データ型では、次の形式を使用します。

fieldName1=[fromValue,toValue]

範囲は、fromValueからtoValueです。fromValueがtoValueよりも小さいことを確認してください。例えば、

filters=age=[35,45]

クエリでは、検索結果が絞り込まれて、35～45歳の年齢層のレコードが検索されます。

日付データ型では、次の形式を使用します。

fieldName1=[fromDate,toDate]

範囲は、fromDateからtoDateです。例えば、

filters=birthdate=[2000-06-12T12:30:00Z,2015-06-12T12:30:00Z]

クエリでは、2000年6月12日～2015年6月12日の誕生日が指定されます。

完全一致の日付フィルタを指定する場合、一重引用符で囲みます。日付範囲を指定する場合は、引用符を使用しないでください。

検索レコード

UTCでの日付と時刻の形式

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ