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

前へ次へ

標準のクエリパラメータ

ビジネスエンティティサービスのREST APIは、標準のクエリパラメータを使用して結果のフィルタリング、ページ区切り、および展開を行います。

疑問符（?）を使用して、クエリパラメータを他のパラメータから切り離します。クエリパラメータは、等号で区切られた、キーと値のペアです。連続したクエリパラメータを区切るには、アンパサンド（&）を使用します。

次のREST要求URLは、クエリパラメータの使用方法を示しています。

/Person/123/Phone/SFA:456/PhoneUse?recordsToReturn=100&recordStates=ACTIVE,PENDING

次に、使用できる標準のクエリパラメータを示します。

パラメータ	説明
recordsToReturn	返す行の数を指定します。デフォルトは10です。
firstRecord	結果の最初の行を指定します。デフォルトは1です。さらにページを読み取るために後続の呼び出しで使用されます。
searchToken	前の要求で返された検索トークンを指定します。検索トークンを使用すると、検索結果の後続のページを取得できます。例えば、 /Person/123/Phone というクエリでは、最初のページが表示されます。 /Person/123/Phone?searchToken=SVR1.AZAM5&firstRecord=10 というクエリでは、2つ目のページが返ります。
returnTotal	trueに設定すると、結果内のレコードの数が返ります。デフォルトはfalseです。
depth	結果に含める子レベルの数を指定します。

ページをウォッチ

フィードバックを送信