kintone API文件

kintone JavaScript API

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

在教程「kintone API入門」中，您可以學習kintone JavaScript API的基礎知識。
kintone API入門

事件

連結已複製

有關如何使用事件的詳細資訊，請參閱以下頁面。
如何編寫事件處理

記錄清單畫面

連結已複製

事件何時發生？ 電腦版 行動裝置版
顯示清單畫面後 app.record.index.show mobile.app.record.index.show
開始進行內聯編輯時 app.record.index.edit.show 無
內聯編輯中變更欄位值時 app.record.index.edit.change.欄位代碼 無
進行內聯編輯後存儲時 app.record.index.edit.submit 無
內聯編輯成功時 app.record.index.edit.submit.success 無
刪除記錄之前 app.record.index.delete.submit 無

記錄詳情畫面

連結已複製

事件何時發生？ 電腦版 行動裝置版
顯示記錄詳情畫面後 app.record.detail.show mobile.app.record.detail.show
刪除記錄之前 app.record.detail.delete.submit mobile.app.record.detail.delete.submit
執行流程管理操作時 app.record.detail.process.proceed mobile.app.record.detail.process.proceed

新增記錄畫面

連結已複製

事件何時發生？ 電腦版 行動裝置版
顯示新增記畫面後 app.record.create.show mobile.app.record.create.show
變更欄位的值時 app.record.create.change.欄位代碼 mobile.app.record.create.change.欄位代碼
儲存時 app.record.create.submit mobile.app.record.create.submit
儲存成功後 app.record.create.submit.success mobile.app.record.create.submit.success

編輯記錄畫面

連結已複製

事件何時發生？ 電腦版 行動裝置版
顯示記錄編輯畫面後 app.record.edit.show mobile.app.record.edit.show
變更欄位的值時 app.record.edit.change.欄位代碼 mobile.app.record.edit.change.欄位代碼
儲存時 app.record.edit.submit mobile.app.record.edit.submit
儲存成功後 app.record.edit.submit.success mobile.app.record.edit.submit.success

記錄列印畫面

連結已複製

事件何時發生？ 電腦版 行動裝置版
顯示記錄列印畫面後 app.record.print.show 無

圖表畫面

連結已複製

事件何時發生？ 電腦版 行動裝置版
顯示圖表畫面後 app.report.show mobile.app.report.show

入口網站畫面

連結已複製

事件何時發生？ 電腦版 行動裝置版
顯示入口網站畫面後 portal.show mobile.portal.show

空間畫面

連結已複製

事件何時發生？ 電腦版 行動裝置版
顯示空間的頂部畫面後 space.portal.show mobile.space.portal.show

註冊或刪除事件處理程式

連結已複製

API 電腦版 行動裝置版
註冊事件處理程式 kintone.events.on() kintone.events.on()
刪除事件處理程式 kintone.events.off() kintone.events.off()

執行API

連結已複製

執行kintone REST API

連結已複製

API 電腦版 行動裝置版
傳送kintone REST API請求 kintone.api() kintone.api()
獲取API的URL kintone.api.url() kintone.api.url()
使用查詢字串獲取API的URL kintone.api.urlForGet() kintone.api.urlForGet()
獲取CSRF權杖 kintone.getRequestToken() kintone.getRequestToken()
獲取kintone REST API的併發連接數 kintone.api.getConcurrencyLimit() kintone.api.getConcurrencyLimit()

API的執行

連結已複製

API 電腦版 行動裝置版
執行外部API kintone.proxy() kintone.proxy()
從外部上傳檔案 kintone.proxy.upload() kintone.proxy.upload()

獲取/設定資訊

連結已複製

記錄

連結已複製

API 電腦版 行動裝置版
獲取記錄ID kintone.app.record.getId() kintone.mobile.app.record.getId()
獲取記錄的值 kintone.app.record.get() kintone.mobile.app.record.get()
給記錄設置值 kintone.app.record.set() kintone.mobile.app.record.set()
獲取當前登入中的使用者的記錄存取權限 kintone.app.record.getPermissions() kintone.app.record.getPermissions()
獲取當前登入中的使用者的記錄欄位存取權限 kintone.app.record.getFieldPermissions() kintone.app.record.getFieldPermissions()
獲取記錄狀態的歷史記錄 kintone.app.record.getStatusHistory() kintone.app.record.getStatusHistory()

應用程式

連結已複製

API 電腦版 行動裝置版
獲取應用程式的資訊 kintone.app.get() kintone.app.get()
獲取應用程式的ID kintone.app.getId() kintone.mobile.app.getId()
大量獲取應用程式欄位資訊 kintone.app.getFormFields() kintone.app.getFormFields()
獲取應用程式表單佈局 kintone.app.getFormLayout() kintone.app.getFormLayout()
獲取應用程式是否為測試環境 kintone.app.isTestEnvironment() kintone.app.isTestEnvironment()
獲取應用程式是否處於維護模式 kintone.app.isMaintenanceMode() kintone.app.isMaintenanceMode()
開啟或關閉應用程式的說明 kintone.app.showDescription(state) 無
獲取應用程式圖示的URL kintone.app.getIcons() kintone.app.getIcons()
獲取記錄清單的欄位元素 kintone.app.getFieldElements(fieldCode) kintone.mobile.app.getFieldElements(fieldCode)
獲取記錄清單功能表右側的元素 kintone.app.getHeaderMenuSpaceElement() 無
獲取記錄清單中功能表的下部元素 kintone.app.getHeaderSpaceElement() 無
取得記錄清單設定 kintone.app.getView() kintone.app.getView()
取得記錄清單 kintone.app.getViews() kintone.app.getViews()
獲取記錄清單的查詢字串 kintone.app.getQueryCondition() kintone.mobile.app.getQueryCondition()
獲取記錄清單的查詢字串（帶選項） kintone.app.getQuery() kintone.mobile.app.getQuery()
獲取標頭的下部元素 無 kintone.mobile.app.getHeaderSpaceElement()
獲取Lookup欄位參照源的應用ID kintone.app.getLookupTargetAppId() kintone.mobile.app.getLookupTargetAppId()
獲取相關記錄清單參照源的應用程式ID kintone.app.getRelatedRecordsTargetAppId() kintone.mobile.app.getRelatedRecordsTargetAppId()
獲取流程管理設置 kintone.app.getStatus() kintone.app.getStatus()
取得流程管理可執行的動作的清單 kintone.app.record.getStatusActions() kintone.app.record.getStatusActions()
獲取流程管理的目前執行者 kintone.app.record.getAssignees() kintone.app.record.getAssignees()
獲取類別的設定資訊 kintone.app.getCategories() kintone.app.getCategories()
獲取當前登入中的使用者的應用程式存取權限 kintone.app.getPermissions() kintone.app.getPermissions()

空間

連結已複製

API 電腦版 行動裝置版
獲取空間的資訊 kintone.space.get() kintone.space.get()
獲取當前登入的使用者的空間存取權限。 kintone.space.getPermissions() kintone.space.getPermissions()

系統

連結已複製

API 電腦版 行動裝置版
獲取功能的啟用狀態 kintone.system.getAvailableFeatures() kintone.system.getAvailableFeatures()
獲取當前登入中的使用者的系統存取權限 kintone.system.getPermissions() kintone.system.getPermissions()

授權

連結已複製

API 電腦版 行動裝置版
獲取當前環境是否為試用環境 kintone.license.isTrial() kintone.license.isTrial()
獲取kintone的合約方案 kintone.license.getSubscriptionPlan() kintone.license.getSubscriptionPlan()

整個

連結已複製

API 電腦版 行動裝置版
獲取當前登入中的使用者的資訊 kintone.getLoginUser() kintone.getLoginUser()
取得當前登入中的使用者的自訂項目 kintone.user.getCustomFields() kintone.user.getCustomFields()
取得當前登入中的使用者所屬的群組（角色） kintone.user.getGroups() kintone.user.getGroups()
取得當前登入中的使用者所屬的組織 kintone.user.getOrganizations() kintone.user.getOrganizations()
獲取目前顯示的畫面 kintone.getPageType() kintone.getPageType()
取得使用者的圖示 kintone.user.getIcons() kintone.user.getIcons()
獲取設計版本 kintone.getUiVersion() kintone.getUiVersion()
獲取是否可用cybozu.com的其他服務 kintone.getAvailableServices() kintone.getAvailableServices()
獲取域名資訊 kintone.getDomain() kintone.getDomain()
獲取可用的API類型 kintone.getAvailableApiTypes() kintone.getAvailableApiTypes()
獲取是否啟用SecureAccess kintone.isAccessWithClientCertificateAuthentication() kintone.isAccessWithClientCertificateAuthentication()
獲取是否透過行動用戶端進行的存取 kintone.isMobileApp() kintone.isMobileApp()
獲取是否是行動裝置版的畫面 kintone.isMobilePage() kintone.isMobilePage()
獲取當前登入中的使用者的資訊 kintone.getUserPreference() kintone.getUserPreference()
獲取當前登入中的使用者是否是cybozu.com共通管理員 kintone.isUsersAndSystemAdministrator() kintone.isUsersAndSystemAdministrator()
獲取當前畫面是否為前端框架改造後的畫面 kintone.isRevampedUI() kintone.isRevampedUI()
顯示確認對話框 kintone.showConfirmDialog() 無
建立對話框 kintone.createDialog() 無
在畫面頂端顯示信息 kintone.showNotification() 無
顯示載入圖示 kintone.showLoading() 無

顯示/隱藏欄位

連結已複製

API 電腦版 行動裝置版
顯示或隱藏欄位 kintone.app.record.setFieldShown() kintone.mobile.app.record.setFieldShown()
打開和關閉組群欄位 kintone.app.record.setGroupFieldOpen() kintone.mobile.app.record.setGroupFieldOpen()
取得欄位的顯示/隱藏狀態 kintone.app.record.isFieldVisible() kintone.mobile.app.record.isFieldVisible()
取得群組欄位的開啟和關閉狀態 kintone.app.record.isGroupFieldOpen() kintone.mobile.app.record.isGroupFieldOpen()

顯示/隱藏元素

連結已複製

API 電腦版 行動裝置版
開啟或關閉應用程式的說明 kintone.app.showDescription() 無
顯示或隱藏新增記錄的按鈕 kintone.app.showAddRecordButton() kintone.mobile.app.showAddRecordButton()
顯示或隱藏應用程式設定按鈕 kintone.app.showAppSettingsButton() 無
顯示或隱藏記錄重複利用按鈕 kintone.app.record.showDuplicateRecordButton() 無
顯示或隱藏記錄上的編輯按鈕 kintone.app.record.showEditRecordButton() kintone.mobile.app.record.showEditRecordButton()
顯示或隱藏篩選按鈕 kintone.app.showFilterButton() kintone.mobile.app.showFilterButton()
顯示/隱藏圖表的下拉選單 kintone.app.showViewAndReportSelector() kintone.mobile.app.showReportSelector()
顯示/隱藏切換清單的下拉選單 kintone.app.showViewAndReportSelector() kintone.mobile.app.showViewSelector()
顯示或隱藏應用程式的選項按鈕 kintone.app.showOptionsButton() kintone.mobile.app.showOptionsButton()
顯示或隱藏切換上一/下一筆記錄的按鈕 kintone.app.record.showPager() kintone.mobile.app.record.showPager()
顯示或隱藏匯總按鈕 kintone.app.showReportButton() 無
顯示或隱藏側邊欄 kintone.app.record.showSideBar() 無

獲取元素

連結已複製

記錄詳情畫面

連結已複製

API 電腦版 行動裝置版
獲取欄位元素 kintone.app.record.getFieldElement() kintone.mobile.app.record.getFieldElement()
獲取功能表上部的元素 kintone.app.record.getHeaderMenuSpaceElement() 無
獲取頁首的下部元素 無 kintone.mobile.app.getHeaderSpaceElement()
獲取空間欄位的元素 kintone.app.record.getSpaceElement() kintone.mobile.app.record.getSpaceElement()

記錄清單畫面

連結已複製

API 電腦版 行動裝置版
獲取欄位元素 kintone.app.getFieldElements() kintone.mobile.app.getFieldElements()
獲取選單的右側元素 kintone.app.getHeaderMenuSpaceElement() 無
獲取選單的下部元素 kintone.app.getHeaderSpaceElement() 無
獲取頁首的下部元素 無 kintone.mobile.app.getHeaderSpaceElement()

入口網站畫面

連結已複製

API 電腦版 行動裝置版
獲取入口網站的上部元素 kintone.portal.getContentSpaceElement() kintone.mobile.portal.getContentSpaceElement()

空間畫面

連結已複製

API 電腦版 行動裝置版
獲取空間的頂部畫面上方的元素 kintone.space.portal.getContentSpaceElement() kintone.mobile.space.portal.getContentSpaceElement()

外掛程式

連結已複製

API 電腦版 行動裝置版
獲取設定資訊 kintone.plugin.app.getConfig() kintone.plugin.app.getConfig()
儲存設定資訊 kintone.plugin.app.setConfig() 無
獲取執行外部API所需的資訊 kintone.plugin.app.getProxyConfig() 無
儲存執行外部API所需的資訊 kintone.plugin.app.setProxyConfig() 無
執行外部API kintone.plugin.app.proxy() kintone.plugin.app.proxy()
從外部上傳檔案 kintone.plugin.app.proxy.upload() kintone.plugin.app.proxy.upload()