FormLayout
Exposes the structure of an app's form layout, allowing you to review or update how sections, fields, and elements are arranged for end users.
Select
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM FormLayout WHERE AppId = 6 SELECT * FROM FormLayout WHERE AppId = 6 AND Lang = 'en' SELECT * FROM FormLayout WHERE AppId = 6 AND IsPreview = false
Update
For updating the FormLayout, provide the Layout as an aggregate. All fields in the form must be specified in the aggregate. The AppId column is required to update the FormLayout.
UPDATE FormLayout SET Layout = '[{"type":"ROW","fields":[{"type":"SPACER","code":"Table_0","size":{"width":"200"}}]}]' WHERE AppId = 6
Columns
| Name | Type | ReadOnly | References | Description |
| AppId [KEY] | Integer | False |
Identifier of the Kintone app whose form layout configuration is being retrieved or updated. | |
| Fields | String | False |
List of fields contained in the layout row, representing the elements displayed together in that section of the form. | |
| Type | String | False |
Type of layout row, indicating how the row is structured and how its fields are arranged within the form. The allowed values are ROW, SUBTABLE, GROUP. | |
| Code | String | False |
Field code of the Table or Group field associated with the row, returned only when the row represents one of these container types. | |
| Revision | String | True |
Revision number of the app settings, helping track changes made to the form layout over time. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| IsPreview | Boolean |
Indicates whether to retrieve form-layout details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
| Layout | String |
Value used only when performing an insert or update to supply modified layout definitions. |