ページネーションサーチ Web メソッドの使用
この Web メソッドは、検索条件に基づいて 1 つ以上のビジネス オブジェクトを取得します。 これは Microsoft SQL スタイルのクエリです。 他の検索 Web メソッドと比較して、この汎用 Web メソッドを使用すると、任意の複雑なクエリを表現できます。
リクエスト構文
FRSHEATIntegrationSearchResponse PaginationSearch(文字列セッションキー、文字列テナントID、ObjectQueryDefinitionクエリ、intスキップ)パラメータ
- sessionKey: Connect Web メソッドからのセッション キー。
- tenantId: セッション キーが認証されるテナント。
- クエリ: 検索条件を記述する構造。 これは、Microsoft SQL Select 要求の構造に従い、 Top、 Where、 Join、および Order By 句を含む、Select クエリで可能なほとんどのパラメーターを取得します。 PaginationSearch メソッドでは、 Top 値がページ サイズ パラメータとして考慮されます。 Top が指定されていない場合、このメソッドはデフォルトで 100 件のレコードを返します。
- skip : 結果セットの先頭からスキップする必要があるレコードの数を示す整数値 (つまり、offset パラメータと同様)。
戻り値
FRSHEATIntegrationSearchResponse オブジェクトは次のように定義されます。
パブリッククラス FRSHEATIntegrationSearchResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
パブリック リスト<List<WebServiceBusinessObject>> objList { get; set; }
}FRSHEATIntegrationSearchResponse クラスには次のフィールドがあります。
- ステータス: 操作が成功したかどうかを示すステータス値を提供します。 使用可能なステータス値の詳細な説明は、以下の表に記載されています。
- exceptionReason: Connect Web メソッドの実行時にシステムが例外をスローした場合の例外情報が含まれます。
- objList: ステータス フィールドの値が成功の場合、見つかった結果のリストが含まれます。 検索条件が複数のビジネス オブジェクトに一致した場合、外部リストには複数のビジネス オブジェクトが含まれます。 検索条件が結合を要求した場合、内部リストには結合されたビジネス オブジェクトが含まれます。 Microsoft SQL 応答とは異なり、結合された各オブジェクトのフィールドは個別のリストに保持されます。 それらは混ざり合っていません。 リクエストで Top 値を指定しない場合、 objList はデフォルトで結果リストから上位 100 件のレコードを返します。
以下の表に、使用可能なステータス値とその解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | ビジネス オブジェクトが正常に見つかりました。 objList フィールドからビジネス オブジェクト リストにアクセスすると、結果が WebServiceBusinessObjectsのリストとして返されます。 |
エラー | ビジネス オブジェクトが見つかりません。 objList フィールドが null です。 対応する exceptionReason フィールドを調べて、Web メソッドが失敗した理由を特定します。 一般的なエラーの例を次に示します。
ビジネス オブジェクトの名前が正しく入力されていることを確認します。
フィールド名が正しく入力され、指定されたビジネス オブジェクトに対して定義されていることを確認します。 |
見つかりません | 指定されたビジネス オブジェクトはテナント内に存在しますが、指定された RecID はオブジェクト内の既存のレコードのいずれとも一致しません。 これは例外的な条件ではないため、 exceptionReason フィールドには例外は保存されませんが、 objList フィールドは null になります。 目的のレコードの RecID がテナント内に存在することを確認します。 |
- Appserver webconfig プロパティを使用して、デフォルトの Top 最大値を設定できます。 <add key="DefaultMaxNumberOfRecordsRestAPI" value="100" />
- Top の値を 0に指定すると、 PaginationSearch メソッドはデフォルトで 100 件のレコードを返します。
