FAQ：API で 200 レコードを超えるデータを取得したい
## 回答
POSTするパラメータで「Offset」を指定してください
---
## 概要
複数レコードを取得する際 API からの応答に含まれるレコードの件数は 「[Api.json](/manual/api-json)」の PageSize(デフォルトで 200) が最大となります。
Offset を指定するとことで、後続のレコードを取得することができます。
## 注意事項
1. システム全体の負荷とならないよう、基本的には View パラメータによって、取得件数を絞ることを検討してください。
1. 「[Api.json](/manual/api-json)」 の PageSize を大きくすることでの対応は、一度に多量のデータを応答することになり、サーバ側およびクライアント側の処理の負荷を増大させる可能性があります。
## 操作手順
1. レスポンスの TotalCount が、レスポンスの PageSize を超えている場合、取得できていないレコードが存在します。
2. Offset を追加したリクエストをすることで、後続のレコードを取得します。
### レコード件数の確認
以下のようなリクエストを行うと、レコードの件数の情報が取得できます。
このとき `(開始位置 + 一度に取得できる件数) > 全件` となっているかをチェックすることで、未取得のレコードがあることをコード的に判定できます。
```javascript
const siteId = 123456; // レコードを取得するサイトのサイト ID
$p.apiGet({
id: siteId,
done: (e) => console.log({'全件':e.Response.TotalCount, '一度に取得できる件数':e.Response.PageSize, '開始位置':e.Response.Offset})
});
```
### オフセットを指定したレコードの取得
以下のように data として Offset を指定することで、結果取得位置を繰り下げることができます。
```javascript
const siteId = 123456; // レコードを取得するサイトのサイト ID
$p.apiGet({
id: siteId,
data: {Offset:200},
done: (e) => console.log(e.Response.Data);
});
```
前述のように、レスポンスの Offset と PageSize の和と TotalCount 以上となった場合に末尾まで取得できたことを判定できるため、この条件を満たすまで繰り返し実行することで、ページング処理を実施できます。
実業務においては、ページング処理中にデータ更新が行われることにるデータの並び順の変更や新規作成、削除により、単純にページングを実施しても全てのレコードをスキャンできない可能性があることを考慮してください。
## 関連情報
<div id="ManualList"><ul><li><a href="/manual/api-json">パラメータ設定：Api.json</a><span>2023/04/27 up</span></li></ul></article></div><input id="SearchTextHidden" type="hidden" value="" />
