## Overview In version 1.3.13.0, the default API version will change from 1.0 to 1.1, altering the data layout of API requests and responses. In addition, a bug in versions before 1.3.12.0, where the ApiVersion was not correctly set in requests without an API key, has been resolved, resulting in similar changes. Parameter adjustments are required to maintain compatibility with API calls developed in the older version. # Changes in API Version 1.0/1.1 The data layout of API requests and responses will change as follows: ## Version 1.0 The data layout of the "[Class Column](/en/manual/table-management-class)", "[Numeric Value Column](/en/manual/table-management-num)", "「Date Column」", "「Description Column」", "「Check Column」", and "「Attachment Column」" is expressed in a flat structure. In version 1.0, responses for the above columns are, for example, from ClassA to Class100 for class column. If you need responses for Class101 and beyond, please use version 1.1. ```json { "ApiVersion": 1.0, "Title": "API 1.0", "ClassA": "ClassA", "NumA": 123, "DateA": "2022/7/2", "DescriptionA": "DescriptionA", "CheckA": true } ``` ## Version 1.1 The data layout of the "[Class Column](/en/manual/table-management-class)", "[Numeric Value Column](/en/manual/table-management-num)", "「Date Column」", "「Description Column」", "「Check Column」", and "「Attachment Column」" will be changed to KeyValue format. ```json { "ApiVersion": 1.1, "Title": "API 1.1", "ClassHash": { "ClassA": "ClassA" }, "NumHash": { "NumA": 123 }, "DateHash": { "DateA": "2022/7/2" }, "DescriptionHash": { "DescriptionA": "DescriptionA" }, "CheckHash": { "CheckA": true } } ``` # How to Specify API Version The default API version is set by a parameter. It can also be explicitly specified by the API request parameters. ## "[Api.json](/en/manual/api-json)" Version Parameter This version is used for API calls that do not specify the API version. The default value is 1.1. If users want to change to the specifications of the older version, change it to 1.0. ## Request Parameters The API version can be specified in the request parameters when executing the API. If not specified, the value of the Version parameter in Api.json will be used. To use the old version specification, specify 1.0. ### "[Record Retrieval API](/en/manual/api-record-get)" Request ##### JSON ``` { "ApiVersion": 1.0, "ApiKey": "63Kfk0ds3d4S2DBsa32..." } ``` ### Request for "[$p.apiGet](/ja/manual/script-api-get)" ``` $p.apiGet({ id: <site ID>, data: { "ApiVersion": 1.0, <other retrieval conditions> }, done: <optional processing>, fail: <optional processing>, always: <optional processing> }); ``` # Compatibility_1_3_12 Parameter in [Api.json](/en/manual/api-json) This is a setting to maintain compatibility if you have API calls affected by the bug in versions before 1.3.12.0 (where ApiVersion was not correctly set in requests without an API key). The default value is false. If you are using such API calls, change this parameter to true and set the Version in Api.json to 1.0. Note that this bug did not occur in the .NET Framework version, so set this to false when migrating from the .NET Framework version. ## Correspond API Call For cases where ApiVersion is specified but ApiKey is not, there was a bug in versions before 1.3.12.0 where the ApiVersion 1.1 specification was ignored, and it operated with version 1.0. This bug is fixed in version 1.3.13.0 and later, changing the behavior to ApiVersion 1.1. ```json { "ApiVersion": 1.1 "Title": "1.0" } ``` ### Compatibility_1_3_12: False behavior The bug is fixed, and it operates with the specified API version. |ApiVersion|ApiKey|Behavior| |:----|:----|:----| |Not specified| |Api.json version| |1.0|Specified|1.0| |1.0|Not specified|1.0| |1.1|Specified|1.1| |1.1|Not specified|**1.1**| ### Compatibility_1_3_12: True behavior The specification of ApiVersion is ignored as in versions before 1.3.12.0. |ApiVersion|ApiKey|Behavior| |:----|:----|:----| |Not specified| |Api.json version| |1.0|Specified|1.0| |1.0|Not specified|1.0| |1.1|Specified|1.1| |1.1|Not specified|**Api.json version**| ## Related Information <div id="ManualList"><ul><li><a href="/en/manual/api-json">Set Parameter: Api.json</a><span>08.13.2024 up</span></li></ul></article> <ul><li><a href="/en/manual/table-management-class">Table Management: Item: Classification</a><span>08.13.2024 up</span></li> <li><a href="/en/manual/table-management-num">Manage Table: Column: Numerical Value</a><span>10.02.2024 up</span></li></ul></article> <ul><li><a href="/en/manual/api-record-get">Developer Function: API: Table Operation: Retrieve Single Record</a><span>08.14.2024 up</span></li> <li><a href="/en/manual/api-record-get-multi">Developer Function: API: Table Operation: Retrieve Multiple Records</a><span>08.14.2024 up</span></li></ul></article> <ul><li><a href="/en/manual/script-api-get">Developer Function: Script: $p.apiGet</a><span>10.04.2024 up</span></li></ul></article></div><input id="SearchTextHidden" type="hidden" value="" />