SCIM でのページネーション
ページネーション機能は、大量のレスポンスをより簡単な方法で処理するために使用します。ページネーションを使用すると、count パラメータを設定することで、ページ内に表示する結果の数を制限することができます。また、ナビゲーション内の現在のページに基づいて前のページおよび次のページに簡単に移動することもできます。ページネーション リクエスト パラメータと、その説明およびデフォルト値を以下の表に示します。
cad140jp
ページネーション機能は、大量のレスポンスをより簡単な方法で処理するために使用します。ページネーションを使用すると、count パラメータを設定することで、ページ内に表示する結果の数を制限することができます。また、ナビゲーション内の現在のページに基づいて前のページおよび次のページに簡単に移動することもできます。
ページネーション リクエスト パラメータと、その説明およびデフォルト値を以下の表に示します。
パラメータ | 説明 | デフォルト |
startIndex | 最初のクエリ結果の 1 から始まるインデックスです。1 未満の値は、 1 として解釈されます。 | 1 |
count | 負数以外の整数値。1 ページに表示したいクエリ結果の数を指定します。例: 10。負の値は「0」として解釈されます。値「0」は、合計結果の場合以外、リソースの結果が返されないことを示します。 | なし。指定されている場合、サービス プロバイダは、指定より少ない結果を返すことはできますが、指定より多くの結果を返すことはできなくなります。指定しない場合、結果の最大数は、サービス プロバイダによって設定されます。 |
ページネーション応答エレメントを以下の表に示します。
エレメント | 説明 |
itemsPerPage | 負数以外の整数値。クエリ応答ページ 1 ページに返されるクエリ結果の数を指定します。例: 10。 |
totalResults | 負数以外の整数値。クエリに一致する結果の合計数を指定します。例: 1000。 |
startIndex | 現在のクエリ結果セットの最初の結果の 1 から始まるインデックスです。例: 1。 |
例:
以下の例では、startIndex が 1 に、count が 10 に設定されており、最初の 10 件のユーザが取得されます。
GET /Users?startIndex=1&count=10Host: example.comAccept: application/scim+jsonAuthorization: Bearer h480djs93hd8The response to the query above returns metadata regarding pagingsimilar to the following example:{"totalResults":100,"itemsPerPage":10,"startIndex":1,"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"Resources":[{...}]}
注
: 上の例でページングを続行するには、startIndex を 11 に設定して再取得します。つまり、/Users?startIndex=11&count=10 と設定します。