變更表單的佈局
變更應用表單的佈局。
此 API 允許您變更以下設定:
- 欄位的高度和寬度
- 表格中的欄位及其順序
- 群組欄位中的欄位及其佈局
- 設置標籤、空白欄和分割線
此 API 可變更測試環境中的應用。
如果要將變更套用到正式環境,請在執行該API之後,執行將應用設置反映到正式環境的API。
將應用設置傳播到正式環境API
URL
- 常規應用程式
- https://sample.cybozu.com/k/v1/preview/app/form/layout.json
- 訪客空間的應用程式
- https://sample.cybozu.com/k/guest/
GUEST_SPACE_ID
/v1/preview/app/form/layout.json
HTTP 方法
PUT
所需存取權限
- 應用程式管理權限
請求
參數
為表單上的所有欄位指定佈局。參數省略時,其設置不會變更。
參數名稱 | 類型 | 必須 | 說明 |
---|---|---|---|
app | 數值或字串 | 必須 | 應用ID |
layout | 陣列 | 必須 | 表單的逐行佈局清單 |
layout[].type | 字串 | 必須 | 行類型
|
layout[].code | 字串 | 部分條件下必須 | 表格或群組的域代碼layout[].type 為 「SUBTABLE」或「GROUP」時,則為必須項。 |
layout[].fields | 陣列 | 必須 | 行中的欄位清單 |
layout[].fields[].type | 字串 | 必須 | 欄位類型
|
layout[].fields[].code | 字串 | 部分條件下必須 | 欄位代碼layout[].fields[].type 如果不是「LABEL」、「SPACER」或「HR」,則為必須項。 |
layout[].fields[].label | 字串 | 可省略 | 標籤欄位的標籤名稱layout[].fields[].type 為「LABEL」時要指定。如果省略,則設置空字元。 |
layout[].fields[].elementId | 字串 | 可省略 | 空白欄欄位的元素 IDlayout[].fields[].type 為「SPACER」時要指定。如果省略,則設置空字元。 |
layout[].fields[].size | 物件 | 可省略 | 欄位的大小 根據欄位的位置,可能與指定的大小不同。 |
layout[].fields[].size.width | 數值或字串 | 可省略 | 欄位的寬度(以像素為單位) 您可以在以下欄位中指定它:
|
layout[].fields[].size.height | 數值或字串 | 可省略 | 欄位的高度(以像素為單位),包括欄位名稱layout[].fields[].type 為「SPACER」時要指定。 |
layout[].fields[].size.innerHeight | 數值或字串 | 可省略 | 欄位的高度(以像素為單位),不包括欄位名稱 以下欄位可指定:
|
layout[].layout | 陣列 | 可省略 | 群組中欄位的佈局清單 結構與 layout 相同。 |
revision | 數值或字串 | 可省略 | 預期修訂號 如果它與實際修訂號不匹配,則會發生錯誤,並且不會添加該欄位。 如果指定值「-1」或未指定值,則不會驗證修訂號。 |
示例請求
URL
https://sample.cybozu.com/k/v1/preview/app/form/layout.json
標頭
|
|
有關請求頭的詳細資訊,請參閱通用規格。
kintone REST API通用規範
內文
|
|
回應
屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
revision | 字串 | 變更應用設置后的修訂號 |
應答範例
|
|
示例代碼
使用 curl 的請求
|
|
kintone.api()
請求使用
有關詳細的kintone.api()
,請參閱以下頁面。
發送kintone REST API請求
|
|