6.6. ページネーション制御のある検索の使用
per_page および page ページネーションパラメーターを使用して、API 検索クエリーが返した検索結果を絞り込むことができます。per_page パラメーターは、ページごとに表示する結果数を指定し、page パラメーターは per_page パラメーターの計算に合わせて、どのページを返すかを指定します。
ページネーションパラメーターを指定しない場合に、返す項目数のデフォルト値を 1000 に設定しますが、page パラメーターが指定されている場合には per_page のデフォルト値は 20 が適用されます。
コンテンツビューの表示
以下の例では、複数ページにわたるコンテンツビューのリストを返します。このリストでは、ページごとにキー 10 個が含まれており、3 ページ目を返します。
要求例:
$ curl --request GET --user My_User_Name:My_Password \ https://satellite.example.com/katello/api/content_views?per_page=10&page=3
アクティベーションキーの表示
以下の例では、ID が 1 の組織のアクティベーションキーリストを複数ページで返します。このリストには、ページごとにキーが 30 個含まれており、2 ページ目が返されます。
要求例:
$ curl --request GET --user My_User_Name:My_Password \ https://satellite.example.com/katello/api/activation_keys?organization_id=1&per_page=30&page=2
複数ページを返す設定
for loop 構造を使用して、複数ページにわたる結果を取得します。
以下の例では、ページごとに 5 件ずつ表示するコンテンツビュー 3 ページ分の 1 ページを返します。
$ for i in seq 1 3; do \
curl --request GET --user My_User_Name:My_Password \
https://satellite.example.com/katello/api/content_views?per_page=5&page=$i; \
done