欄位格式

kintone API通用

連結已複製

欄位資訊

連結已複製

在應用程式中使用kintone JavaScript API或kintone REST API操作記錄資訊時，需要根據欄位的格式取得或設定欄位的值。
有兩種方法可以指定欄位：

方法1：指定欄位名稱。
以下欄位需要指定欄位名稱。
- 類別
- 狀態
- 執行者
方法2：指定欄位代碼。
對於方法1中列出的欄位以外的欄位，請指定欄位代碼。
您可以在應用程式的表單設定中找到欄位代碼。
設定欄位代碼時的注意事項

記錄ID和記錄編號

連結已複製

記錄ID是自動分配給記錄的數值，不會與其他記錄重複。
如果要在API中指定特定記錄，請使用記錄ID。

記錄編號是自動分配給記錄的編號，不會與其他記錄重複。
根據是否設定了應用代碼，值的格式會有所不同。

如果您尚未設定應用代碼：與記錄ID相同。
如果您已設定應用代碼：這是應用代碼和記錄ID的組合。
例如，如果將應用代碼設定為「APPCODE」，則記錄ID為1的記錄的記錄編號為「APPCODE-1」。

修飾表單的欄位

連結已複製

以下欄位是修飾表單的欄位。
您無法取得、新增或更新該值。

標籤
空白欄
分隔線
群組

如果要取得或變更表單的設定資訊，請使用以下API。

標籤、空間和分隔線
- 用於取得表單佈局的API
- 用於變更表單佈局的API
群組
- 用於新增欄位的API
- 用於變更欄位設定的API
- 用於取得欄位清單的API
- 用於刪除欄位的API cybozu.dev/zh-tw/id/7217d82119f8399506fb6f25/

數值欄位

連結已複製

在kintone JavaScript API中，可以在數值欄位中取得或重寫的值如下。

數值
- 符號可使用「+」或「-」作為。
- 小數點分隔符中「.」可以使用
- 可使用指數標記。指數的符號可使用「e」或「E」。
空字串

數值或符號只能使用半型字串。

此外，如果使用`或事件對象重寫欄位的值，數值欄位可使用以下值：

undefined``null
如果指定這些值，則數值欄位的值將為空。
#INVALID!
如果指定此值，則不會重寫數值欄位的值。

不滿足上述條件的值將被視為無效。

有關kintone.app.record.set()的說明，請參閱以下頁面。
給記錄設定值

Lookup欄位

連結已複製

以kintone JavaScript API取得Lookup欄位的值時，除了value之外，還可以取得表示Lookup狀態的confirmed和recordId的資訊。
這些資訊無法透過kintone REST API取得。

警告

confirmed和recordId，是開發評估中的功能。

若要使用，請在更新選項的「研議中的新功能」中，啟用「在Lookup欄位中觸發『變更欄位值時的事件』」。
設定方法請參閱kintone說明的啟用／停用新功能的步驟。

屬性	類型	說明
value	字串	會填入與Lookup欄位設定中「複製來源的欄位」所指定欄位相同格式的值。
confirmed	布林值	參照來源的記錄是否已確定當參照來源的記錄已確定時，以及按下【清除】清除所參照的記錄時，會變為`true`。
recordId	字串	參照來源記錄的記錄ID 當Lookup欄位未輸入值時，以及即使已輸入但參照來源的記錄尚未確定時，會變為「null」。

value、confirmed、recordId會依當下Lookup欄位的狀態而形成以下組合。
組合的範例如下。

Lookup欄位的狀態	value	confirmed	recordId
輸入「kintone」，且已取得參照來源的記錄時	"kintone"	true	"（記錄ID）"
輸入「kintone」，但尚未取得參照來源的記錄時	"kintone"	false	null
未輸入時（初始狀態，或清除之後）	""	true	null

已取得參照來源記錄時的物件範例如下。

1
2
3
4
5
6


"欄位代碼": {
  "type": "SINGLE_LINE_TEXT",
  "value": "kintone",
  "confirmed": true,
  "recordId": "10"
}

欄位格式

連結已複製

取得值時

連結已複製

欄位代碼請替換為自身應用程式的欄位代碼。

記錄資訊欄位

欄位類型	type	value的示例
記錄編號	RECORD_NUMBER	如果您尚未設定應用程式代碼 "欄位代碼": { "type": "RECORD_NUMBER", "value": "1" } 在應用代碼中指定「APPCODE」時 "欄位代碼": { "type": "RECORD_NUMBER", "value": "APPCODE-1" }
記錄ID	__ID__	"$id": { "type": "__ID__", "value": "1" }
校訂	__REVISION__	"$revision": { "type": "__REVISION__", "value": "5" }
建立人	CREATOR	如果是常規使用者 "欄位代碼": { "type": "CREATOR", "value": { "code": "sato", "name": "NoboruSato" } } 訪客身分驗證 "欄位代碼": { "type": "CREATOR", "value": { "code": "guest/sato@example.com", "name": "NoboruSato" } }
建立時間	CREATED_TIME	"欄位代碼": { "type": "CREATED_TIME", "value": "2012-01-11T11:30:00Z" } 有關格式和時區的更多資訊，請參閱以下頁面。日期和時間格式
更新人	MODIFIER	如果是常規使用者 "欄位代碼": { "type": "MODIFIER", "value": { "code": "sato", "name": "NoboruSato" } } 訪客身分驗證 "欄位代碼": { "type": "MODIFIER", "value": { "code": "guest/sato@example.com", "name": "NoboruSato" } }
更新時間	UPDATED_TIME	"欄位代碼": { "type": "UPDATED_TIME", "value": "2012-01-11T11:30:00Z" }

自訂欄位

欄位類型	type	value的示例
單行文字方塊	SINGLE_LINE_TEXT	"欄位代碼": { "type": "SINGLE_LINE_TEXT", "value": "測試。" }
多行文字方塊	MULTI_LINE_TEXT	"欄位代碼": { "type": "MULTI_LINE_TEXT", "value": "測試\n。" }
文字編輯方塊	RICH_TEXT	"欄位代碼": { "type": "RICH_TEXT", "value": "<a href=\"http://www.example.com\">範例</a>" }
數值	NUMBER	"欄位代碼": { "type": "NUMBER", "value": "123" } kintone JavaScript API中可用於數值欄位的值，請參考數值欄位。數值欄位
計算	CALC	"欄位代碼": { "type": "CALC", "value": "123" } `value`格式取決於顯示格式設定。數值：「1234」數值（以逗號分隔）：「1234」日期與時間：「2012-01-11T11:30:00Z」日期「2012-01-11」時間：「11:30」時間（小時/分鐘）：「49:30」（屏幕上顯示「49小時30分鐘」）時間（天小時分）「49:30」（屏幕上顯示「2天1小時30分鐘」）
核取方塊	CHECK_BOX	"欄位代碼": { "type": "CHECK_BOX", "value": [ "選項1", "選項2" ] }
選項按鈕	RADIO_BUTTON	"欄位代碼": { "type": "RADIO_BUTTON", "value": "選項 }
複選	MULTI_SELECT	"欄位代碼": { "type": "MULTI_SELECT", "value": [ "選項1", "選項2" ] }
下拉式選單	DROP_DOWN	"欄位代碼": { "type": "DROP_DOWN", "value": "選項 }
選擇使用者	USER_SELECT	如果是常規使用者 "欄位代碼": { "type": "USER_SELECT", "value": [ { "code": "sato", "name": "Noboru Sato" }, { "code": "kato", "name": "Misaki Kato" } ] } 訪客身分驗證 "欄位代碼": { "type": "USER_SELECT", "value": [ { "code": "guest/sato@example.com", "name": "Noboru Sato" }, { "code": "guest/kato@example.com", "name": "Misaki Kato" } ] }
選擇組織	ORGANIZATION_SELECT	"欄位代碼": { "type": "ORGANIZATION_SELECT", "value": [ { "code": "kaihatsu", "name": "開發部" }, { "code": "jinji", "name": "人事部" } ] }
選擇群組	GROUP_SELECT	"欄位代碼": { "type": "GROUP_SELECT", "value": [ { "code": "project_manager", "name": "項目經理" }, { "code": "team_leader", "name": "組長" } ] }
日期	DATE	"欄位代碼": { "type": "DATE", "value": "2012-01-11" } 有關格式和時區的更多資訊，請參閱以下頁面。日期和時間格式
時間	TIME	"欄位代碼": { "type": "TIME", "value": "11:30" } 有關格式和時區的更多資訊，請參閱以下頁面。日期和時間格式
日期與時間	DATETIME	"欄位代碼": { "type": "DATETIME", "value": "2012-01-11T11:30:00Z" } 有關格式和時區的更多資訊，請參閱以下頁面。日期和時間格式
連結	LINK	"欄位代碼": { "type": "LINK", "value": "http://www.example.com/" }
附件	FILE	"欄位代碼": { "type": "FILE", "value": [ { "contentType": "text/plain", "fileKey":"201202061155587E339F9067544F1A92C743460E3D12B3297", "name": "17to20_VerupLog （1）.txt", "size": "23175" }, { "contentType": "text/plain", "fileKey": "201202061155583C763E30196F419E83E91D2E4A03746C273", "name": "17to20_VerupLog.txt", "size": "23175" } ] } 取得時回應中包含的檔案鍵僅可用於檔案下載。
Lookup	SINGLE_LINE_TEXT NUMBER LINK ^*1	如果索引鍵欄位為SINGLE_LINE_TEXT "欄位代碼": { "type": "SINGLE_LINE_TEXT", "value": "Code001" } 如果索引鍵欄位為NUMBER "欄位代碼": { "type": "NUMBER", "value": "10" } 如果索引鍵欄位為LINK "欄位代碼": { "type": "LINK", "value": "https://api.example.com" } 在kintone JavaScript API中，除了`value`之外，也可以取得`confirmed`和`recordId`的資訊。請參閱以下內容。 Lookup欄位
表格	SUBTABLE	"欄位代碼": { "type": "SUBTABLE", "value": [ { "id": "48290", "value": { "單行文字方塊_0": { "type": "SINGLE_LINE_TEXT", "value": "樣品1" }, "數值_0": { "type": "NUMBER", "value": "1" }, "核取方塊_0": { "type": "CHECK_BOX", "value": ["選項1"] } } }, { "id": "48291", "value": { "字串_0": { "type": "SINGLE_LINE_TEXT", "value": "樣品2" }, "數值_0": { "type": "NUMBER", "value": "2" }, "核取方塊_0": { "type": "CHECK_BOX", "value": ["選項2"] } } } ] }
相關記錄清單	REFERENCE_TABLE	無法取得該值。
類別	CATEGORY	"類別": { "type": "CATEGORY", "value": [ "category1", "category2" ] }
狀態	STATUS	"狀態": { "type": "STATUS", "value": "未處理" }
執行者	STATUS_ASSIGNEE	"執行者": { "type": "STATUS_ASSIGNEE", "value": [ { "code": "sato", "name": "Noboru Sato" } ] }
標籤	LABEL	無法取得該值。
空白欄	SPACER	無法取得該值。
分隔線	HR	無法取得該值。
群組	GROUP	無法取得該值。

^*1 這取決於鍵欄位的欄位類型。 ^

新增或更新值時

連結已複製

欄位代碼請替換為自身應用程式的欄位代碼。

記錄資訊欄位

欄位類型	type	value的示例
記錄編號	RECORD_NUMBER	您無法新增或更新該值。
記錄ID	__ID__	您無法新增或更新該值。
校訂	__REVISION__	您無法新增或更新該值。
建立人	CREATOR	如果是常規使用者 "欄位代碼": { "value": { "code": "sato" } } 訪客身分驗證 "欄位代碼": { "value": { "code": "guest/sato@example.com" } } 無法更新該值。
建立時間	CREATED_TIME	"欄位代碼": { "value": "2012-01-11T11:30:00Z" } 不能指定將來的日期。無法更新該值。有關格式和時區的更多資訊，請參閱以下頁面。日期和時間格式
更新人	MODIFIER	如果是常規使用者 "欄位代碼": { "value": { "code": "sato" } } 訪客身分驗證 "欄位代碼": { "value": { "code": "guest/sato@example.com" } } 無法更新該值。
更新時間	UPDATED_TIME	"欄位代碼": { "value": "2012-01-11T11:30:00Z" } 無法更新該值。有關格式和時區的更多資訊，請參閱以下頁面。日期和時間格式

自訂欄位

欄位類型	type	value的示例
單行文字方塊	SINGLE_LINE_TEXT	"欄位代碼": { "value": "測試。" }
多行文字方塊	MULTI_LINE_TEXT	"欄位代碼": { "value": "測試\n。" }
文字編輯方塊	RICH_TEXT	"欄位代碼": { "value": "<a href=\"http://www.example.com\">範例</a>" }
數值	NUMBER	"欄位代碼": { "value": "123" } kintone JavaScript API中可用於數值欄位的值，請參考數值欄位。數值欄位
計算	CALC	您無法新增或更新該值。
核取方塊 ^*1	CHECK_BOX	"欄位代碼": { "value": [ "選項1", "選項2" ] }
選項按鈕 ^*1	RADIO_BUTTON	"欄位代碼": { "value": "選項 } 若指定空字串，則自動設定為預設值。
複選 ^*1	MULTI_SELECT	"欄位代碼": { "value": [ "選項1", "選項2" ] }
下拉式選單 ^*1	DROP_DOWN	"欄位代碼": { "value": "選項 }
選擇使用者	USER_SELECT	如果是常規使用者 "欄位代碼": { "value": [ { "code": "sato" }, { "code": "kato" } ] } 訪客身分驗證 "欄位代碼": { "value": [ { "code": "guest/sato@example.com" }, { "code": "guest/kato@example.com" } ] }
選擇組織	ORGANIZATION_SELECT	"欄位代碼": { "value": [ { "code": "kaihatsu" }, { "code": "jinji" } ] }
選擇群組	GROUP_SELECT	"欄位代碼": { "value": [ { "code": "project_manager" }, { "code": "team_leader" } ] }
日期	DATE	"欄位代碼": { "value": "2012-01-11" } 有關格式和時區的更多資訊，請參閱以下頁面。日期和時間格式
時間	TIME	"欄位代碼": { "value": "11:30" } 有關格式和時區的更多資訊，請參閱以下頁面。日期和時間格式
日期與時間	DATETIME	"欄位代碼": { "value": "2012-01-11T11:30:00Z" } 有關格式和時區的更多資訊，請參閱以下頁面。日期和時間格式
連結	LINK	"欄位代碼": { "value": "http://www.example.com/" }
附件	FILE	"欄位代碼": { "value": [ { "fileKey":"84a0e9be-c687-4ae6-82be-3b7edab82c21", }, { "fileKey": "722258d8-55e7-41ed-8208-adf3bd034e50", } ] }
Lookup	SINGLE_LINE_TEXT NUMBER LINK ^*2	"欄位代碼": { "value": "Code001" } 新增或更新時，請確保關聯的應用程式中的複製來源欄位值為唯一。
表格	SUBTABLE	"欄位代碼": { "value": [ { "id": "48290", "value": { "單行文字方塊_0": { "type": "SINGLE_LINE_TEXT", "value": "樣品1" }, "數值_0": { "type": "NUMBER", "value": "1" }, "核取方塊_0": { "type": "CHECK_BOX", "value": ["選項1"] } } }, { "id": "48291", "value": { "字串_0": { "type": "SINGLE_LINE_TEXT", "value": "樣品2" }, "數值_0": { "type": "NUMBER", "value": "2" }, "核取方塊_0": { "type": "CHECK_BOX", "value": ["選項2"] } } } ] } 不要向單個表添加大量行。根據應用程式的配置方式，有可能會給伺服器帶來很大負荷，並且會影響記錄的處理，例如查看記錄或使用REST API與記錄交互。有關使用REST和JavaScript API處理表時的注意事項，請參閱：使用表格時的注意事項
相關記錄清單	REFERENCE_TABLE	您無法新增或更新該值。
類別	CATEGORY	您無法新增或更新該值。
狀態	STATUS	您無法新增或更新該值。
執行者	STATUS_ASSIGNEE	您無法新增或更新該值。
標籤	LABEL	您無法新增或更新該值。
空白欄	SPACER	您無法新增或更新該值。
分隔線	HR	您無法新增或更新該值。
群組	GROUP	您無法新增或更新該值。

^*1 value中輸入在kintone應用程式的表單設定的「項目與順序」中設定的值。
可以在API中指定已刪除的選項項。 ^

^*2 這取決於鍵欄位的欄位類型。 ^

使用表格時的注意事項

透過JavaScript API添加和更新

新增或更新表時，請指定所有現有行的值。
行的順序是請求資料的順序。
在表中新增或更新時，需要指定欄位類型。
有關說明，請參閱以下頁面。
重寫欄位的值

使用REST API添加和更新

新增或更新表時，請指定所有現有行的值。
如為指定列的id，則被視為新增列。要更新現有的列，請指定列的id。
行的順序是請求資料的順序。
如果只想對行進行排序，請求數據只需包含要更改行的id。

添加或刪除行時

您可以通過在表的「value」參數中的值陣列中新增或刪除行物件來在表中添加或刪除行。

以下代碼是在push()中添加一行的範例。

1

record['表格']['value'].push(row);

以下代碼是pop()中刪除行的範例。

1

record['表格']['value'].pop();

不過，在新增／編輯記錄畫面的事件中，如果刪除表格內已存在值的Lookup欄位所在的列，只有Lookup欄位的值會出現非預期的行為

如果欄位的值為空

連結已複製

如果取得空欄位的值，則該欄位的值如下所示：

欄位類型	價值示例
單行文字方塊多行文字方塊數值日期與時間連結 Lookup	"value": "" 在新增記錄畫面或編輯記錄畫面上使用JavaScript API時 "value": undefined
文字編輯方塊	"value": ""
日期時間	"value": null 在新增記錄畫面或編輯記錄畫面上使用JavaScript API時 "value": undefined
下拉式選單	"value": "" 使用REST API時 "value": null 在新增記錄畫面或編輯記錄畫面上使用JavaScript API時 "value": undefined
選項按鈕	使用REST API時 "value": null 使用JavaScript API時 "value": ""
核取方塊複選選擇使用者選擇組織選擇群組附件表格類別執行者	"value": []

如果要將欄位的值設定為空

連結已複製

如果要將欄位設定為空值，請按如下方式設定該欄位的值：

欄位類型	價值示例
單行文字方塊多行文字方塊文字編輯方塊下拉式選單日期與時間連結 Lookup	"value": "" 或 "value": null
數值	指定以下值之一： "value": "" "value": undefined "value": null
日期時間	"value": null
核取方塊複選選擇使用者選擇組織選擇群組附件表格	"value": []
選項按鈕類別執行者	無

kintone API

kintone API文件

欄位格式

目錄

欄位資訊

記錄ID和記錄編號

修飾表單的欄位

相關記錄清單

數值欄位

Lookup欄位

警告

欄位格式

取得值時

記錄資訊欄位

自訂欄位

新增或更新值時

記錄資訊欄位

自訂欄位

使用表格時的注意事項

透過JavaScript API添加和更新

使用REST API添加和更新

添加或刪除行時

如果欄位的值為空

如果要將欄位的值設定為空