Update Form Layout
Updates the field layout info of a form in an App.
This API updates the pre-live settings.
After using this API, use the following API to deploy the settings to the live App:
Deploy App Settings
Method | PUT |
---|---|
URL | https://{subdomain}.kintone.com/k/v1/preview/app/form/layout.json |
URL(guest space) | https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/form/layout.json |
Authentication | Password Authentication , API Token Authentication , Session Authentication |
Content-Type | application/json |
Permissions
- App Management Permissions are needed.
Request Parameters
Parameters that are ignored will not be updated
All fields in the form must be specified in the request.
Parameter | Value | Required | Description |
---|---|---|---|
app | Integer | Yes | The App ID. |
layout | Array | Yes | A list of field layouts for each row. |
layout[].type | String | Yes | The type of row.
|
layout[].code | String | Conditional | The field code of the Table or Group field. Ignore, if the row type is not a Table or a Group. |
layout[].fields | Array | The list of fields in the row. | |
layout[].fields[].type | String | Yes | The type of field.
|
layout[].fields[].code | String | Conditional | The field code of the field. Ignore, if the field is a Label, Blank space or a Border. |
layout[].fields[].label | String | The text to set into the Label field. Only specify for Label fields. |
|
layout[].fields[].elementId | String | The element ID to set to the Blank space field. Only specify for Blank space fields. | |
layout[].fields[].size | Object | An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. |
|
layout[].fields[].size.width | Integer | The width of the field in pixels. The width can be set for the following fields:
|
|
layout[].fields[].size.height | Integer | The height of the field in pixels, including the height of the field name. Only Blank space fields can use this parameter. |
|
layout[].fields[].size.innerHeight | Integer | The height of the field in pixels, excluding the height of the field name. Only the following fields can use this parameter:
|
|
layout[].layout | Array | A list of field layouts for each row inside a Group field. The parameters for this are the same for the layout property. |
|
revision | Integer | Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or -1 is specified. |
Sample Request
|
|
XMLHttpRequest
|
|
Response Parameters
Parameter | Type | Description |
---|---|---|
revision | String | The revision number of the App settings. |
Sample Response
|
|