關於kintone REST API的使用方法，請參考以下教程。
我們以kintone REST API為例
記錄
連結已複製
選取/註冊/更新/刪除記錄
連結已複製
| HTTP 方法 | URL | |
|---|---|---|
| 選取單個記錄 | GET | /k/v1/record.json |
| 註冊單條記錄 | POST | /k/v1/record.json |
| 更新單個記錄 | PUT | /k/v1/record.json |
| 獲取多條記錄 | GET | /k/v1/records.json |
| 註冊多條記錄 | POST | /k/v1/records.json |
| 更新多條記錄 | PUT | /k/v1/records.json |
| 刪除多條記錄 | DELETE | /k/v1/records.json |
| （批量獲取紀錄）建立游標 | POST | /k/v1/records/cursor.json |
| （批量獲取紀錄）從游標選取記錄 | GET | /k/v1/records/cursor.json |
| （批量獲取紀錄）刪除游標 | DELETE | /k/v1/records/cursor.json |
刪除記錄的回覆
連結已複製
| HTTP 方法 | URL | |
|---|---|---|
| 選取記錄的回覆 | GET | /k/v1/record/comments.json |
| 貼文記錄回覆 | POST | /k/v1/record/comment.json |
| 刪除記錄的回覆 | DELETE | /k/v1/record/comment.json |
操作流程管理
連結已複製
| HTTP 方法 | URL | |
|---|---|---|
| 更新記錄上的執行者 | PUT | /k/v1/record/assignees.json |
| 更新單個記錄的狀態 | PUT | /k/v1/record/status.json |
| 更新多條記錄的狀態 | PUT | /k/v1/records/status.json |
其他
連結已複製
| HTTP 方法 | URL | |
|---|---|---|
| 批量多應用記錄操作 | POST | /k/v1/bulkRequest.json |
| 獲取執行API的用戶記錄的存取權限 | GET | /k/v1/records/acl/evaluate.json |
檔案
連結已複製
| HTTP 方法 | URL | |
|---|---|---|
| 下載檔案 | GET | /k/v1/file.json |
| 上傳檔案 | POST | /k/v1/file.json |
應用程式
連結已複製
應用的API中有兩個URL。
詳情請參閱各檔。
- 在測試環境中反映的URL以檢查應用程式的運行：「/k/v1/preview/
API_PATH.json」 - 受生產啟發的URL：「/k/v1/
API_PATH.json」
應用程式資訊
連結已複製
| HTTP 方法 | URL | |
|---|---|---|
| 選取單個應用的資訊 | GET | /k/v1/app.json |
| 選取多個應用的資訊 | GET | /k/v1/apps.json |
| 在工作測試環境中創建應用 | POST | /k/v1/preview/app.json |
| 獲取應用程式管理的使用情況 | GET | /k/v1/apps/statistics.json |
| 選取應用程式管理員用備註 | GET |
/k/v1/app/adminNotes.json /k/v1/preview/app/adminNotes.json |
| 變更應用程式管理員用備註 | PUT | /k/v1/preview/app/adminNotes.json |
表單
連結已複製
| HTTP 方法 | URL | |
|---|---|---|
| 選擇欄位 | GET |
/k/v1/app/form/fields.json /k/v1/preview/app/form/fields.json |
| 新增欄位 | POST | /k/v1/preview/app/form/fields.json |
| 變更欄位的設置 | PUT | /k/v1/preview/app/form/fields.json |
| 刪除欄位 | DELETE | /k/v1/preview/app/form/fields.json |
| 獲取表單的佈局 | GET |
/k/v1/app/form/layout.json /k/v1/preview/app/form/layout.json |
| 變更表單的佈局 | PUT | /k/v1/preview/app/form/layout.json |
| 獲取表單的設計資訊 | GET |
/k/v1/form.json /k/v1/preview/form.json |
清單
連結已複製
| HTTP 方法 | URL | |
|---|---|---|
| 獲取清單設置 | GET |
/k/v1/app/views.json /k/v1/preview/app/views.json |
| 變更清單的設置 | PUT | /k/v1/preview/app/views.json |
圖表
連結已複製
| HTTP 方法 | URL | |
|---|---|---|
| 獲取圖表的設置 | GET |
/k/v1/app/reports.json /k/v1/preview/app/reports.json |
| 變更應用程式的設定 | PUT | /k/v1/preview/app/reports.json |
應用程式的設定
連結已複製
一般設定
| HTTP 方法 | URL | |
|---|---|---|
| 獲取應用的一般設定 | GET |
/k/v1/app/settings.json /k/v1/preview/app/settings.json |
| 變更應用程式的一般設定 | PUT | /k/v1/preview/app/settings.json |
| 獲取流程管理設置 | GET |
/k/v1/app/status.json /k/v1/preview/app/status.json |
| 變更流程管理的設置 | PUT | /k/v1/preview/app/status.json |
| 確認應用設置在正式環境中的反映狀態 | GET | /k/v1/preview/app/deploy.json |
| 將應用設置傳播到正式環境 | POST | /k/v1/preview/app/deploy.json |
自訂/服務整合
| HTTP 方法 | URL | |
|---|---|---|
| 獲取已新增到應用的外掛程式清單 | GET |
/k/v1/app/plugins.json /k/v1/preview/app/plugins.json |
| 將外掛程式添加到您的應用程式 | POST | /k/v1/preview/app/plugins.json |
| 獲取JavaScript/CSS自訂設定 | GET |
/k/v1/app/customize.json /k/v1/preview/app/customize.json |
| 變更 JavaScript/CSS 自訂設置 | PUT | /k/v1/preview/app/customize.json |
通知
| HTTP 方法 | URL | |
|---|---|---|
| 獲取應用的條件通知設置 | GET |
/k/v1/app/notifications/general.json /k/v1/preview/app/notifications/general.json |
| 變更應用程式的通知條件設置 | PUT | /k/v1/preview/app/notifications/general.json |
| 獲取記錄的通知條件的設置 | GET |
/k/v1/app/notifications/perRecord.json /k/v1/preview/app/notifications/perRecord.json |
| 變更記錄的通知條件的設置 | PUT | /k/v1/preview/app/notifications/perRecord.json |
| 獲取提醒的通知條件的設置 | GET |
/k/v1/app/notifications/reminder.json /k/v1/preview/app/notifications/reminder.json |
| 變更提醒的通知條件設置 | PUT | /k/v1/preview/app/notifications/reminder.json |
存取權限
| HTTP 方法 | URL | |
|---|---|---|
| 獲取應用程式的存取權限設置 | GET |
/k/v1/app/acl.json /k/v1/preview/app/acl.json |
| 變更應用程式的存取權限設定 | PUT |
/k/v1/app/acl.json /k/v1/preview/app/acl.json |
| 獲取記錄的存取權限設置 | GET |
/k/v1/record/acl.json /k/v1/preview/record/acl.json |
| 變更記錄的存取權限設置 | PUT |
/k/v1/record/acl.json /k/v1/preview/record/acl.json |
| 獲取欄位的存取權限設置 | GET |
/k/v1/field/acl.json /k/v1/preview/field/acl.json |
| 變更欄位的存取權限設置 | PUT |
/k/v1/field/acl.json /k/v1/preview/field/acl.json |
其他設定
| HTTP 方法 | URL | |
|---|---|---|
| 獲取應用的動作設置 | GET |
/k/v1/app/actions.json /k/v1/preview/app/actions.json |
| 變更應用程式動作的設定 | PUT | /k/v1/preview/app/actions.json |
操作管理
| HTTP 方法 | URL | |
|---|---|---|
| 變更應用程式所屬的空間 | POST | /k/v1/app/move.json |
空間
連結已複製
空間
連結已複製
| HTTP 方法 | URL | |
|---|---|---|
| 獲取有關空間的資訊 | GET | /k/v1/space.json |
| 變更空白欄的設定 | PUT | /k/v1/space.json |
| 建立空間 | POST | /k/v1/template/space.json |
| 刪除空間 | DELETE | /k/v1/space.json |
| 更新空間的內文 | PUT | /k/v1/space/body.json |
| 獲取有關空間成員和空間管理員的資訊 | GET | /k/v1/space/members.json |
| 更新空間的成員 | PUT | /k/v1/space/members.json |
| 獲取空間使用情況 | GET | /k/v1/space/statistics.json |
主題
連結已複製
| HTTP 方法 | URL | |
|---|---|---|
| 建立空間的主題 | POST | /k/v1/space/thread.json |
| 更新空間中的主題 | PUT | /k/v1/space/thread.json |
| 向空間中的話題貼文回覆 | POST | /k/v1/space/thread/comment.json |
訪客用戶和訪客空間
連結已複製
| HTTP 方法 | URL | |
|---|---|---|
| 新增訪客 | POST | /k/v1/guests.json |
| 刪除訪客 | DELETE | /k/v1/guests.json |
| 更新訪客空間的訪客 | PUT |
/k/guest/GUEST_SPACE_ID/v1/space/guests.json
|
外掛程式
連結已複製
| HTTP 方法 | URL | |
|---|---|---|
| 獲取已安裝外掛程式的清單 | GET | /k/v1/plugins.json |
| 獲取需要安裝的外掛程式清單 | GET | /k/v1/plugins/required.json |
| 獲取已新增到應用的外掛程式清單 | GET | /k/v1/plugin/apps.json |
| 匯入外掛程式 | POST | /k/v1/plugin.json |
| 更新外掛程式 | PUT | /k/v1/plugin.json |
| 移除外掛程式 | DELETE | /k/v1/plugin.json |
API資訊
連結已複製
| HTTP 方法 | URL | |
|---|---|---|
| 獲取kintone REST API清單 | GET | /k/v1/apis.json |
| 獲取kintone REST API的Schema資訊 | GET | /k/v1/apis/*.json |