獲取表單的設計資訊
獲取表單的設計資訊。
URL
獲取正式環境設置的URL與獲取測試環境設置的URL不同。
如果要獲取正式環境的設置
- 常規應用程式
- https://sample.cybozu.com/k/v1/form.json
- 訪客空間的應用程式
- https://sample.cybozu.com/k/guest/
GUEST_SPACE_ID
/v1/form.json
獲取操作測試環境的設置
- 常規應用程式
- https://sample.cybozu.com/k/v1/preview/form.json
- 訪客空間的應用程式
- https://sample.cybozu.com/k/guest/
GUEST_SPACE_ID
/v1/preview/form.json
HTTP 方法
GET
所需存取權限
您必須具有以下權限之一:
- 應用程式中記錄的查看權限
- 應用程式中新增記錄的權限
請求
參數
參數名稱 | 類型 | 必須 | 說明 |
---|---|---|---|
app | 數值或字串 | 必須 | 應用的ID |
範例請求(如果要在網址中包含參數 )
URL
https://sample.cybozu.com/k/v1/form.json?app=4
標頭
|
|
有關請求頭的詳細資訊,請參閱通用規格。
kintone REST API通用規範
要求範例(如果要在要求內文中包含參數)
URL
https://sample.cybozu.com/k/v1/form.json
標頭
|
|
有關請求頭的詳細資訊,請參閱通用規格。
kintone REST API通用規範
內文
|
|
回應
屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties | 陣列 | 構成應用的欄位清單properties[].type 不同,其欄位內容也不一樣。詳情見附表。 |
properties[].type | 字串 | 欄位類型 根據類型,將返回以下值:
|
單行文字方塊欄位的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「SINGLE_LINE_TEXT」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].expression | 字串 | 通過自動計算設置的公式 |
properties[].hideExpression | 字串 | 是否顯示計算公式
|
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項
|
properties[].unique | 字串 | 是否允許值重複
|
properties[].minLength | 字串 | 字元數(最小值) 返回一個整數。 如果未設置,則返回「null」。 |
properties[].maxLength | 字串 | 字元數(最大值) 返回一個整數。 如果未設置,則返回「null」。 |
properties[].defaultValue | 字串 | 預設值 如果未設置,則返回「null」。 |
properties[].code | 字串 | 欄位代碼 |
多行文字方塊的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「MULTI_LINE_TEXT」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項
|
properties[].defaultValue | 字串 | 預設值 如果未設置,則返回「null」。 |
properties[].code | 字串 | 欄位代碼 |
文字編輯方塊的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「RICH_TEXT」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項
|
properties[].defaultValue | 字串 | 預設值 如果未設置,則返回「null」。 |
properties[].code | 字串 | 欄位代碼 |
數值的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「NUMBER」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].digit | 字串 | 是否顯示千位分隔符
|
properties[].required | 字串 | 是否設置為必填項
|
properties[].unique | 字串 | 是否允許值重複
|
properties[].minValue | 字串 | 價值限制(最小值) 返回一個整數。 如果未設置,則返回「null」。 |
properties[].maxValue | 字串 | 值限制(最大值) 返回一個整數。 如果未設置,則返回「null」。 |
properties[].defaultValue | 字串 | 預設值 如果未設置,則返回「null」。 |
properties[].displayScale | 字串 | 小數點後的顯示位數 返回一個整數。 如果未設置,則返回「null」。 |
properties[].unit | 字串 | 單位符號 如果未設置,則返回「null」。 |
properties[].unitPosition | 字串 | 單位符號的位置 傳回以下值:
|
properties[].code | 字串 | 欄位代碼 |
計算的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「CALC」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項 返回「false」。 |
properties[].expression | 字串 | 通過自動計算設置的公式 |
properties[].hideExpression | 字串 | 是否顯示計算公式
|
properties[].format | 字串 | 格式 傳回以下值之一:
|
properties[].displayScale | 字串 | 小數點後的顯示位數 返回一個整數。 如果未設置,則返回「null」。 |
properties[].unit | 字串 | 單位符號 如果未設置,則返回「null」。 |
properties[].unitPosition | 字串 | 單位符號的位置 傳回以下值:
|
properties[].code | 字串 | 欄位代碼 |
選項按鈕的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「RADIO_BUTTON」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項 返回「true」。 |
properties[].options | 陣列(array) | 項目清單 |
properties[].defaultValue | 字串 | 預設值 如果未設置,則返回「null」。 |
properties[].code | 字串 | 欄位代碼 |
核取方塊的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「CHECK_BOX」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項
|
properties[].options | 陣列(array) | 項目清單 |
properties[].defaultValue | 字串 | 預設值 如果未設置,則返回「null」。 |
properties[].code | 字串 | 欄位代碼 |
複選的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「MULTI_SELECT」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項
|
properties[].options | 陣列(array) | 項目清單 |
properties[].defaultValue | 字串 | 預設值 如果未設置,則返回「null」。 |
properties[].code | 字串 | 欄位代碼 |
下拉屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「DROP_DOWN」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項
|
properties[].options | 陣列(array) | 項目清單 |
properties[].defaultValue | 字串 | 預設值 如果未設置,則返回「null」。 |
properties[].code | 字串 | 欄位代碼 |
選擇使用者的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「USER_SELECT」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項
|
properties[].code | 字串 | 欄位代碼 |
選擇組織的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「ORGANIZATION_SELECT」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項
|
properties[].code | 字串 | 欄位代碼 |
選擇群組的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「GROUP_SELECT」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項
|
properties[].code | 字串 | 欄位代碼 |
日期的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「DATE」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項
|
properties[].unique | 字串 | 是否允許值重複
|
properties[].defaultValue | 字串 | 預設值 如果未設置,則返回「null」。 |
properties[].defaultExpression | 字串 | 預設值里設置的公式 如果未設置,則返回「null」。 |
properties[].code | 字串 | 欄位代碼 |
時間的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「TIME」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項
|
properties[].defaultValue | 字串 | 預設值 如果未設置,則返回「null」。 |
properties[].defaultExpression | 字串 | 預設值里設置的公式 如果未設置,則返回「null」。 |
properties[].code | 字串 | 欄位代碼 |
日期與時間的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「DATETIME」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項
|
properties[].unique | 字串 | 是否允許值重複
|
properties[].defaultValue | 字串 | 預設值 如果未設置,則返回「null」。 |
properties[].defaultExpression | 字串 | 預設值里設置的公式 如果未設置,則返回「null」。 |
properties[].code | 字串 | 欄位代碼 |
附件的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「FILE」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項
|
properties[].code | 字串 | 欄位代碼 |
連結的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「LINK」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項
|
properties[].unique | 字串 | 是否允許值重複
|
properties[].protocol | 字串 | 連結類型 傳回以下值之一:
|
properties[].minLength | 字串 | 字元數(最小值) 返回一個整數。 如果未設置,則返回「null」。 |
properties[].maxLength | 字串 | 字元數(最大值) 返回一個整數。 如果未設置,則返回「null」。 |
properties[].defaultValue | 字串 | 預設值 如果未設置,則返回「null」。 |
properties[].code | 字串 | 欄位代碼 |
相關記錄清單的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「REFERENCE_TABLE」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].relatedApp | 數位 | 要連結的應用的應用ID |
properties[].code | 字串 | 欄位代碼 |
Lookup的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 根據複製來源的欄位類型,將傳回以下值之一:
|
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].required | 字串 | 是否設置為必填項
|
properties[].relatedApp | 數位 | 要連結的應用的應用ID |
properties[].code | 字串 | 欄位代碼 |
表格的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「TABLE」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].relatedApp | 數位 | 要連結的應用的應用ID |
properties[].fields | 陣列 | 表中的欄位清單 |
properties[].code | 字串 | 欄位代碼 |
標籤屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「LABEL」。 |
properties[].label | 字串 | 欄位名稱 |
空白欄的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「SPACE」。 |
properties[].elementId | 字串 | 元素的ID |
分割線的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「HR」。 |
記錄編號屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「RECORD_NUMBER」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].code | 字串 | 欄位代碼 |
建立人的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「CREATOR」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].code | 字串 | 欄位代碼 |
建立時間的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「CREATED_TIME」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].code | 字串 | 欄位代碼 |
更新人的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「MODIFIER」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].code | 字串 | 欄位代碼 |
更新時間的屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
properties[].type | 字串 | 欄位類型 返回「UPDATED_TIME」。 |
properties[].label | 字串 | 欄位名稱 |
properties[].noLabel | 字串 | 是否隱藏欄位名稱
|
properties[].code | 字串 | 欄位代碼 |
示例回應
|
|
示例代碼
使用 curl 的請求
|
|
kintone.api()
請求使用
有關詳細的kintone.api()
,請參閱以下頁面。
發送kintone REST API請求
|
|
限制事項
- 以下欄位不可獲取:
- 類別
- 狀態
- 群組
- 群組內的以下欄位
- 記錄號碼
- 建立人
- 建立時間
- 更新人
- 更新時間
- 空白欄
- 標籤
- 分隔線