獲取表單的佈局
獲取表單的佈局。
您可以取得以下設定:
- 表中的欄位以及欄位的排序順序
- 您放入組欄位中的欄位及其佈局
- 標籤、空格和邊框設置
如果要獲取欄位清單, 請使用 API 獲取欄位清單。
URL
獲取生產環境的設置時,URL 與獲取測試環境的設置時不同。
如果要獲取生產環境的設置
- 常規應用
- https://sample.cybozu.com/k/v1/app/form/layout.json
- 建立訪客空間
- https://sample.cybozu.com/k/guest/
GUEST_SPACE_ID
/v1/app/form/layout.json
獲取操作測試環境的設置
- 常規應用
- 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 方法
GET
所需許可權
如果要獲取生產環境的設置
您必須具有以下權限之一:
- 查看應用程式中記錄的許可權
- 在應用程式中添加記錄的許可權
獲取操作測試環境的設置
- 應用程式管理
請求
參數
參數名稱 | 型 | 必須 | 說明 |
---|---|---|---|
app | 數位或字串 | 必須 | 應用ID |
範例請求(如果在網址中包含參數 )
URL
https://sample.cybozu.com/k/v1/app/form/layout.json?app=8
頁眉
|
|
關於請求頭,請參見 kintone REST API的通用規範 。
範例要求(如果要在要求正文中包含參數)
URL
https://sample.cybozu.com/k/v1/app/form/layout.json
頁眉
|
|
關於請求頭,請參見 kintone REST API的通用規範 。
身體
|
|
回應
財產
屬性名稱 | 型 | 說明 |
---|---|---|
layout | 陣列 | 表單的逐行佈局清單 |
layout[].type | 字串 | 行類型
|
layout[].code | 字串 | 表或組的代碼 對於表、組以外的行,不列印此參數。 |
layout[].fields | 陣列 | 行中的欄位清單 |
layout[].fields[].type | 字串 | 欄位類型
|
layout[].fields[].code | 字串 | 欄位代碼 |
layout[].fields[].label | 字串 | 標籤 它在標籤欄位中輸出。 |
layout[].fields[].elementId | 字串 | 要素 ID 它在空間欄位中輸出。 |
layout[].fields[].size | 物件 | 欄位的大小 在PC上查看時的欄位大小。在行動裝置上查看時,您無法獲得欄位大小。 |
layout[].fields[].size.width | 字串 | 欄位的寬度(以像素為單位) |
layout[].fields[].size.height | 字串 | 欄位的高度(以像素為單位),包括欄位名稱 |
layout[].fields[].size.innerHeight | 字串 | 欄位的高度(以像素為單位),不包括欄位名稱 |
layout[].layout | 陣列 | 組中欄位的佈局清單 |
revision | 字串 | 應用設置的修訂號 |
示例回應
|
|
示例代碼
使用 curl 的請求
|
|
發送kintone REST API請求 使用API 發送請求
|
|