概念: WQL クエリー結果のページング
クエリを最初に実行すると、クエリー パラメータの Workday Query Language (WQL) が実行され、最大 10,000 行を返すキャッシュが構築されます。追加行にアクセスするには、以下のキーを使用して結果セットをページングする必要があります。
limit
および offset
WQL クエリーに対する REST API 呼び出しのパラメータ。WQL では、ユーザー セッションの長さ分だけページ制限リクエストをキャッシュします。
残りの結果を表示するには、以下のパラメータを使用します。
パラメータ | 説明 |
|---|---|
limit
| 結果の 1 ページあたりの行数を指定します。値は、0 ～ 10,000 の間である必要があります。 |
offset
| 結果セットの開始行を指定します。以下で使用 limit パラメータ。
結果の最初のページに対する最初のリクエストでは、 offset パラメータ、またはゼロに設定します。 |
このキーワードは予約されています
LIMIT
句とページング パラメータの両方に対して。LIMIT キーワードでは大文字と小文字が区別されません。- 以下を使用します。LIMIT句。クエリーの応答で返される合計行数を制限します。
- 以下を使用します。limitパラメータを設定し、クエリー応答のページごとに表示する行数を指定します。
例
WQL リクエストをどこから作成するかによって、使用する基本 URL は異なります。
WQL リクエスト ソース
| 使用する基本 URL
|
|---|---|
Workday テナント ホスト | https://{hostname}/api/wql/{version}/{tenant}
|
WCP API ゲートウェイ | https://api.workday.com/wql/{version}
|
結果セットの最初の行から開始して 1,000 行を返すには、次のようにします。
{baseURL}/data?limit=1000&offset=0&query=select worker, location from allWorkers
次の 1,000 行を返すには、オフセットを 1,000 に増加します。
{baseURL}/data?limit=1000&offset=1000&query=select worker, location from allWorkers