開発者向け機能:JSONデータレイアウト:共通
## 概要
APIやサーバスクリプトでレコードを操作する際に指定するJSON形式のデータレイアウトです。
## 制限事項
1. 💎が添えられたSsCacheプロパティは、年間サポートサービス(ビジネスプラン、ビジネスプラスプラン、アンリミテッドプランのいずれか)の契約期間中またはトライアル期間中に利用できます。対象外のプランでは利用できません。詳細は[こちら](https://pleasanter.org/support/)を参照してください。
## JSONデータのレイアウト
|No|プロパティ名|項目名|データ型|備考|
|:----|:----|:----|:----|:----|
|1|ApiVersion|APIのバージョン|long|省略時は[Api.json](/ja/manual/api-json)の「ApiVersion」で指定したバージョンで動作|
|2|ApiKey|あらかじめ作成した[APIキー](/ja/manual/api-key)|string|操作するテーブル、操作する内容に応じた権限をもつユーザで作成したAPIキーを設定|
|3|Offset|データ取得するAPIやスクリプトにおいて取得を開始するレコードの位置|long|省略時は0(1件目から取得開始)。[PageSize](/ja/manual/faq-api-paging)の値以降のレコードを取得する場合に設定します。詳細は[FAQ:API で 200 レコードを超えるデータを取得したい](/ja/manual/faq-api-paging)を参照してください。|
|4|PageSize|データ取得するAPIやスクリプトにおいて取得可能な上限値|long|省略時は[Api.json](/ja/manual/api-json)の[PageSize](/ja/manual/faq-api-paging)で指定した値。[Api.json](/ja/manual/api-json)のPageSizeよりも大きな値を設定した場合はPageSizeの値として動作します。|
|5|SsCache💎|サイト設定のキャッシュを有効化・無効化する。SsCacheを指定しない場合、またはfalseを指定した場合は、キャッシュを無効化する。|bool|[テーブルの管理](/ja/manual/table-management)画面の「全般」タブに表示される[サイト設定のキャッシュを有効化](/ja/manual/enable-site-settings-cache)でも有効化・無効化を切り替えられます。API経由での設定と画面経由での設定は独立して動作します。|
## 対応バージョン
|対応バージョン|内容|
|:--|:--|
|1.4.13.0 以降|PageSizeを追加|
|1.5.6.0 以降|SsCacheを追加|
## 関連情報
<div id="ManualList"><ul><li><a href="/ja/manual/api-json">パラメータ設定:Api.json</a><span>2024/12/12 up</span></li></ul></article>
<ul><li><a href="/ja/manual/enable-site-settings-cache">サイト設定のキャッシュを有効化</a><span>2026/07/14 up</span></li></ul></article>
<ul><li><a href="/ja/manual/table-management">テーブルの管理</a><span>2025/12/09 up</span></li></ul></article>
<ul><li><a href="/ja/manual/api-key">開発者向け機能:API:APIキーの作成</a><span>2025/04/10 up</span></li></ul></article>
<ul><li><a href="/ja/manual/faq-api-paging">FAQ:API で 200 レコードを超えるデータを取得したい</a><span>2024/04/29 up</span></li></ul></article></div><input id="SearchTextHidden" type="hidden" value="" />



