獲取表單的佈局

連結已複製

獲取表單的佈局。

HTTP 方法	GET
URL	https://sample.cybozu.com/k/v1/app/form/layout.json
URL（訪客空間）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/app/form/layout.json
URL（操作測試環境）	https://sample.cybozu.com/k/v1/preview/app/form/layout.json
URL（測試環境中的訪客空間）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/app/form/layout.json
認證	密碼驗證 , API令牌認證 , 會話認證 , OAuth認證
Content-Type	application/json（透過查詢字串指定查詢時不需指定此項）

請求參數

連結已複製

參數名稱	類型	必須	說明
app	數值或字串	必須	應用程式ID

應答屬性

連結已複製

屬性名稱	類型	說明
layout	陣列	表單的逐行佈局清單
layout[].type	字串	行類型 `ROW`：標準線 `SUBTABLE`：表格 `GROUP`：群組欄位
layout[].code	字串	表格或群組的代碼對於表、群組以外的行，不列印此參數。
layout[].fields	陣列	行中的欄位清單
layout[].fields[].type	字串	欄位類型 `CALC`：計算 `CHECK_BOX`：核取方塊 `CREATED_TIME`：建立時間 `CREATOR`：建立人 `DATE`：日期 `DATETIME`：日期與時間 `DROP_DOWN`：下拉式選單 `FILE`：附件 `GROUP_SELECT`：選擇群組 `HR`：分隔線 `LABEL`：標籤 `LINK`：連結 `MODIFIER`：更新人 `MULTI_LINE_TEXT`：多行文字方塊 `MULTI_SELECT`：複選 `NUMBER`：數值 `ORGANIZATION_SELECT`：選擇組織 `RADIO_BUTTON`：選項按鈕 `RECORD_NUMBER`：記錄號碼 `REFERENCE_TABLE`：相關記錄清單 `RICH_TEXT`：文字編輯方塊 `SINGLE_LINE_TEXT`：單行文字方塊 `SPACER`：空間 `TIME`：時間 `UPDATED_TIME`：更新時間 `USER_SELECT`：選擇使用者 Lookup欄位由從中複製該欄位的欄位類型表示。
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	字串	應用設置的修訂號

所需存取權限

連結已複製

取得正式環境的設定

連結已複製

您必須具有以下權限之一：

應用程式中記錄的查看權限
應用程式的記錄添加權限

取得操作測試環境的設定

連結已複製

應用程式管理權限

範例

連結已複製

請求範例

請求URL（在URL中包含參數的情況）

1

https://sample.cybozu.com/k/v1/app/form/layout.json?app=8

請求標頭（在URL中包含參數的情況）

1
2
3


{
  "X-Cybozu-API-Token": "API_TOKEN"
}

有關請求頭的詳細資訊，請參閱通用規格。
kintone REST API通用規格

請求URL（在請求主體中包含參數的情況）

1

https://sample.cybozu.com/k/v1/app/form/layout.json

請求標頭（在請求主體中包含參數的情況）

1
2
3
4


{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

有關請求頭的詳細資訊，請參閱通用規格。
kintone REST API通用規格

請求主體

1
2
3


{
  "app": "8"
}

範例回應

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77


{
  "revision": "2",
  "layout": [
    {
      "type": "ROW",
      "fields": [
        {
          "type": "SINGLE_LINE_TEXT",
          "code": "單行文字方塊_0",
          "size": {
            "width": "200"
          }
        },
        {
          "type": "MULTI_LINE_TEXT",
          "code": "多行文字方塊_0",
          "size": {
            "width": "200",
            "innerHeight": "100"
          }
        },
        {
          "type": "LABEL",
          "label": "label",
          "size": {
            "width": "200"
          }
        },
        {
          "type": "SPACER",
          "elementId": "spacer",
          "size": {
            "width": "200",
            "height": "100"
          }
        },
        {
          "type": "HR",
          "size": {
            "width": "200"
          }
        }
      ]
    },
    {
      "type": "SUBTABLE",
      "code": "表格_0",
      "fields": [
        {
          "type": "NUMBER",
          "code": "數值_0",
          "size": {
            "width": "200"
          }
        }
      ]
    },
    {
      "type": "GROUP",
      "code": "群組_0",
      "layout": [
        {
          "type": "ROW",
          "fields": [
            {
              "type": "NUMBER",
              "code": "數值_1",
              "size": {
                "width": "200"
              }
            }
          ]
        }
      ]
    }
  ]
}

範例程式碼

使用kintone.api()傳送請求

有關kintone.api()的說明，請參閱以下頁面。
傳送kintone REST API請求

1
2
3
4
5


const body = {
  app: 1
};

await kintone.api(kintone.api.url('/k/v1/app/form/layout.json', true), 'GET', body);

使用curl傳送請求

根據您的環境，curl的格式可能會有所不同。
有關說明，請參閱以下頁面。
使用curl命令執行kintone REST API/3.執行API

1
2
3
4
5
6


curl -X GET 'https://sample.cybozu.com/k/v1/app/form/layout.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1
  }'

補充

連結已複製

使用此API取得以下設定：
- 表中的欄位以及欄位的排序順序
- 您放入組欄位中的欄位及其佈局
- 標籤/空格/分隔線的設置
如果要獲取欄位清單，請使用獲取欄位清單API。
用於獲取欄位清單的API

kintone API

kintone API文件

獲取表單的佈局

目錄

請求參數

應答屬性

所需存取權限

取得正式環境的設定

取得操作測試環境的設定

範例

補充