Common
Overview
This is the JSON format data layout specified when manipulating records with API or server script.
Limitations
- The SsCache property marked with 💎 is available during the contract period of the Annual Support Service (Business, Business Plus, or Unlimited plan) or during the trial period. It is not available with other plans. For details, see Annual Support Service.
JSON data layout
| No | Property name | Column name | Data type | Notes |
| 1 | ApiVersion | API version | long | If omitted, it will operate with the version specified in "ApiVersion" in "Api.json" |
| 2 | ApiKey | Pre-created "API Key" | string | Set the API key created by a user with the appropriate permissions for the table to be operated and the operation content |
| 3 | Offset | Position of the record from which to start retrieving data in an API or script that retrieves data | long | If omitted, 0 (retrieval starts from the first record). Set it when retrieving records after the value of PageSize. For details, see "I want to retrieve data exceeding 200 records via API". |
| 4 | PageSize | Upper limit of the number of records that can be retrieved in an API or script that retrieves data | long | If omitted, the value specified in PageSize in Api.json. If a value larger than PageSize in Api.json is set, it works as the value of PageSize. |
| 5 | SsCache💎 | Enables or disables the cache of the site settings. If SsCache is not specified, or if false is specified, the cache is disabled. | bool | You can also switch it on or off with "Enable Site Settings Cache" on the "General" tab of the "Manage Table" screen. The setting through the API and the setting on the screen work independently. |
Supported Versions
| Supported version | Contents |
| 1.4.13.0 or later | PageSize added |
| 1.5.6.0 or later | SsCache added |