このページを共有

# ページデータ (limit、offset、total_count)

このセクションでは、ALM Octane REST APIを使用するときに返されるページデータを制限する方法について説明します。

このトピックの内容:

## 概要

クエリが大量のデータセットを返す場合、結果は一連のページで返されます。クライアントは、すでに受信したデータを処理した後、次のページを要求します。

ページ付けにより、次のことが可能になります。

- サーバーから限られた結果のコレクションを取得します。

- サーバーからの結果のコレクションをオフセットします。

ページ付けするには、キーワードlimitとoffsetを使用します。

ヒント:

大規模なコレクションでは、後のページを取得するときにパフォーマンスが低下します。データベースサーバーへのストレスを回避する他の方法は、必要なデータのみを取得することにより、クエリによって返されるデータのサイズを制限することです。

- クエリ句を使用して、返されるインスタンスをフィルタリングします。クエリを参照してください。

- fields句を使用して、必要なフィールドのみを取得します。フィールドの選択を参照してください。

トップに戻る

## Limit: クエリでページサイズを指定する

queryパラメーターを使用して、各ページで返すインスタンスの数を指定できます。

limitの構文は次のとおりです。limit =<limit_value>

limit_valueは整数であり、0より大きくなければなりません。

例: `defects?limit=20`

注意: limitクエリパラメーターが1より小さいか、最大ページサイズより大きい場合、例外がスローされます。

- これにより、サーバーから返されるリソースコレクションの結果の数が特定の数の結果に制限されます。

- 応答のtotal_countプロパティは、フィルターに応答するエンティティの実際の数 (特定のページによってもたらされるエンティティを含む) を示します。

- 制限パラメーターが指定されていない場合は、標準設定の制限が使用されます。

トップに戻る

## Offset: ページを開始する場所の指定

クエリパラメーターオフセットは、クエリの結果から返される最初の位置を設定します。標準設定は0で、最初の結果からページを開始します。

オフセットの構文は次のとおりです。`offset =<offset_value>`

offset_valueは整数であり、0以上である必要があります。

- これにより、結果でサーバーから返されるコレクションの開始点がオフセットされます。

- オフセットパラメーターが指定されていない場合は、番号0が使用されます。

例: システムに100個の不具合があります。40～49の場所で10個の不具合を取得するには、以下を送信します。

`/defects?limit=10&offset=40`

トップに戻る

参照情報:

- コレクションのクエリ
- フィールドの選択
- 結果の並べ替え (order_by)
- クエリ

https://admhelp.microfocus.com ALM Octane 8942
検索結果を改善するためのヒント... ALM Octaneヘルプセンター ALM Octaneヘルプ 15.1.90 すべて ローカルヘルプセンターを表示 オンラインヘルプセンターを表示 戻る ブラウザーの履歴内を戻る 進む ブラウザーの履歴内を進む 検索のハイライトを削除する 次のトピック 次のトピックに進む 前のトピック 前のトピックに戻る 現在のトピックを印刷 バージョン: