獲取表單的佈局
獲取表單的佈局。
您可以獲取以下設定:
- 表中的欄位以及欄位的排序順序
- 您放入組欄位中的欄位及其佈局
- 標籤/空格/分隔線的設置
如果要獲取欄位清單,請使用獲取欄位清單API。
用於獲取欄位清單的 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 | 物件 | 欄位的大小 在電腦上查看時的欄位大小。在行動裝置上查看時,您無法獲得欄位大小。 |
layout[].fields[].size.width | 字串 | 欄位的寬度(以像素為單位) |
layout[].fields[].size.height | 字串 | 欄位的高度(以像素為單位),包括欄位名稱 |
layout[].fields[].size.innerHeight | 字串 | 欄位的高度(以像素為單位),不包括欄位名稱 |
layout[].layout | 陣列 | 群組中欄位的佈局清單 |
revision | 字串 | 應用設置的修訂號 |
應答範例
|
|
示例代碼
使用 curl 的請求
|
|
kintone.api()
請求使用
有關詳細的kintone.api()
,請參閱以下頁面。
發送kintone REST API請求
|
|