使用API進行的操作

記事番号:040820

本文將說明使用API進行操作時輸出的監控日誌。

API operation

模組為[API operation]的監控日誌如下:

App create

以下說明動作為[App create]的監控日誌。

執行的操作

執行在測試環境中建立應用程式的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱

輸出日誌範例

app id: *, app name: *

App deploy

以下說明動作為[App deploy]的監控日誌。

執行的操作

執行將測試環境的應用程式設定套用至正式環境的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 是否取消變更應用程式的設定
    • 取消變更應用程式的設定:true
    • 將變更應用程式的設定套用至正式環境:false

輸出日誌範例

app id: [*], revert: {true/false}

應用程式ID將以逗號分隔輸出。

App update

以下說明動作為[App update]的監控日誌。

執行的操作

對測試環境的應用程式執行變更下列設定的API。

  • 變更[應用程式管理員用備註]
  • 變更[一般設定]的設定
  • 變更[記錄標題]的設定
  • 在[進階設定]畫面中,變更[圖片]的設定
  • 在[進階設定]畫面中,變更[大量刪除]的設定
  • 在[進階設定]畫面中,變更[記錄的回覆]的設定
  • 在[進階設定]畫面中,變更[重複利用記錄]的設定
  • 在[進階設定]畫面中,變更[在記錄清單中直接編輯]的設定
  • 在[進階設定]畫面中,變更[數值和計算的精準度]的設定
  • 在[進階設定]畫面中,變更[第一季度的開始月份]的設定

層級

資訊

輸出至[補充]的內容

變更[應用程式管理員用備註]

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 變更的設定項目(target)

變更的設定項目輸出為[adminNotes]

變更[一般設定]的設定

輸出以下項目:

  • アプリID
  • 應用程式名稱
變更[記錄標題]的設定

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 變更的設定項目的狀態

設定項目狀態為以下其中之一:

  • 在[作為記錄標題的欄位]的設定中選擇[使用自動設定]:AUTO
  • 在[作為記錄標題的欄位]的設定中選擇[選擇欄位]:MANUAL

選擇[選擇欄位]時,也會輸出[作為記錄標題的欄位]的欄位代碼。

變更[進階設定]的設定

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 變更的設定項目及狀態

變更的設定項目輸出為以下內容:

  • [圖片]:enableThumbnails
  • [大量刪除]:enableBulkDeletion
  • [記錄的回覆]:enableComments
  • [重複利用記錄]:enableDuplicateRecord
  • [在記錄清單中直接編輯]:enableInlineRecordEditing
  • [數值和計算的精準度]
  • [第一季度的開始月份]

變更的設定項目的狀態為以下其中之一:

  • 啟用:true
  • 停用:false

[數值和計算的精準度]的設定輸出為下列的值:

  • [總位數]中設定的值:numberPrecision digits
  • [小數位數]中設定的值:numberPrecision decimalPlaces
  • [進位方式]:numberPrecision roundingMode
    • [四捨五入為最相近的偶數]:HALF_EVEN
    • [無條件進位]:UP
    • [無條件捨去]:DOWN

[第一季度的開始月份]的設定,輸出為設定的值(firstMonthOfFiscalYear)。

輸出日誌範例

變更[應用程式管理員用備註]
app id: *, app name: *, target: adminNotes
變更[一般設定]的設定
app id: *, app name: *
變更[記錄標題]的設定
app id: *, app name: *, titleField selectionMode: {AUTO/MANUAL}, titleField code: *
在[進階設定]畫面中,變更[圖片]的設定
app id: *, app name: *, enableThumbnails: {true/false}
在[進階設定]畫面中,變更[大量刪除]的設定
app id: *, app name: *, enableBulkDeletion: {true/false}
在[進階設定]畫面中,變更[記錄的回覆]的設定
app id: *, app name: *, enableComments: {true/false}
在[進階設定]畫面中,變更[重複利用記錄]的設定
app id: *, app name: *, enableDuplicateRecord: {true/false}
在[進階設定]畫面中,變更[在記錄清單中直接編輯]的設定
app id: *, app name: *, enableInlineRecordEditing: {true/false}
在[進階設定]畫面中,變更[數值和計算的精準度]的設定
app id: *, app name: *, numberPrecision digits: *, numberPrecision decimalPlaces: *, numberPrecision roundingMode: {HALF_EVEN/UP/DOWN}
在[進階設定]畫面中,變更[第一季度的開始月份]的設定
app id: *, app name: *, firstMonthOfFiscalYear: *

App status update

以下說明動作為[App status update]的監控日誌。

執行的操作

對測試環境的應用程式執行變更[流程管理]設定的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 啟用/停用流程管理
  • 更新後的狀態名稱清單
  • 更新後的動作名稱清單

狀態名稱清單、動作名稱清單將以預設語言輸出。

輸出日誌範例

app id: *, app name: *, enable: *, status: [*], actions: [*]

App customize update

以下說明動作為[App customize update]的監控日誌。

執行的操作

對測試環境的應用程式執行變更[透過JavaScript/CSS自訂]設定的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱

輸出日誌範例

app id: *, app name: *

Notification update

以下說明動作為[Notification update]的監控日誌。

執行的操作

對測試環境的應用程式執行變更[應用程式的通知條件]、[記錄的通知條件設定]、[提醒的通知條件]設定的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱

輸出日誌範例

app id: *, app name: *

App permission update

以下說明動作為[App permission update]的監控日誌。

執行的操作

執行變更[應用程式的存取權限]設定的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 若為測試環境:preview

輸出日誌範例

正式環境
app id: *, app name: *
測試環境
app id: *, app name: *, preview

Record permission update

以下說明動作為[Record permission update]的監控日誌。

執行的操作

執行變更[記錄的存取權限]設定的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 若為測試環境:preview

輸出日誌範例

正式環境
app id: *, app name: *
測試環境
app id: *, app name: *, preview

Field permission update

以下說明動作為[Field permission update]的監控日誌。

執行的操作

執行變更[欄位的存取權限]設定的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 若為測試環境:preview

輸出日誌範例

正式環境
app id: *, app name: *
測試環境
app id: *, app name: *, preview

App action update

以下說明動作為[App action update]的監控日誌。

執行的操作

對測試環境的應用程式執行變更[動作]設定的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 變更後的動作清單

輸出日誌範例

app id: *, app name: *, actions: [*]

動作清單將以逗號分隔輸出。

App category update

以下說明動作為[App category update]的監控日誌。

執行的操作

執行變更[類別]設定的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱

輸出日誌範例

app id: *, app name: *

App move started

以下說明動作為[App move started]的監控日誌。

執行的操作

執行變更應用程式的所屬空間的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 變更前的空間ID
  • 變更後的空間ID

輸出日誌範例

app id: *, source space id: *, destination space id: *

Form update

以下說明動作為[Form update]的監控日誌。

執行的操作

對測試環境的應用程式執行以下API:

  • 新增欄位
  • 變更欄位的設定
  • 刪除欄位
  • 變更表單的排版

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 新增、變更或刪除的欄位代碼

輸出日誌範例

新增、變更或刪除欄位
app id: *, app name: *, field code: [*]

欄位代碼將以逗號分隔輸出。

更新表單的排版
app id: *, app name: *

App view update

以下說明動作為[App view update]的監控日誌。

執行的操作

對測試環境的應用程式執行變更清單設定的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 變更後的清單一覽

輸出日誌範例

app id: *, app name: *, views: [*]

清單將以逗號分隔輸出。

App report update

以下說明動作為[App report update]的監控日誌。

執行的操作

對測試環境的應用程式執行變更圖表設定的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 變更後的圖表名稱清單

輸出日誌範例

app id: *, app name: *, reports: [*]

圖表名稱清單將以逗號分隔輸出。

Record add

以下說明動作為[Record add]的監控日誌。

執行的操作

執行新增記錄的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 記錄號碼

輸出日誌範例

使用新增一筆記錄的API
app id: *, app name: *, record id: *
使用新增多筆記錄的API
app id: *, app name: *, record id: [*]

記錄號碼將以逗號分隔輸出。

Record update

以下說明動作為[Record update]的監控日誌。

執行的操作

執行更新記錄的API。

層級

資訊

輸出至[補充]的內容

使用更新一筆記錄的API

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 記錄號碼(指定記錄號碼並更新時)
  • 欄位代碼(指定欄位代碼及值並更新時)
  • 指定值(指定欄位代碼及值並更新時)
使用更新多筆記錄的API

輸出以下項目:

停用UPSERT模式並執行
  • 操作
  • アプリID
  • 應用程式名稱
  • 應用程式ID
  • 欄位代碼(指定欄位代碼及值並更新時)
  • 指定值(指定欄位代碼及值並更新時)
啟用UPSERT模式並執行
  • 操作
  • アプリID
  • 應用程式名稱
  • 新增的記錄ID
  • 更新的記錄ID

輸出日誌範例

更新一筆記錄的API
指定記錄號碼並執行
app id: *, app name: *, record id: *
指定欄位代碼及值並執行
app id: *, app name: *, field: *, value: *
更新多筆記錄的API

記錄號碼、欄位代碼、指定值將以逗號分隔輸出。
記錄號碼、記錄key空白時,輸出[]

停用UPSERT模式並執行
operation: update, app id: *, app name: *, record id: [*], record key: [[field: *, value: *]]
啟用UPSERT模式並執行
operation: upsert, app id: *, app name: *, inserted record id: [*], updated record id: [*]

Record delete

以下說明動作為[Record delete]的監控日誌。

執行的操作

執行刪除記錄的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 記錄號碼

輸出日誌範例

app id: *, app name: *, record id: [*]

記錄號碼將以逗號分隔輸出。

Cursor create

以下說明動作為[Cursor create]的監控日誌。

執行的操作

執行建立大量取得記錄用游標的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱

輸出日誌範例

app id: *, app name: *

Record comment get

以下說明動作為[Record comment get]的監控日誌。

執行的操作

執行取得記錄回覆的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 記錄號碼
  • 回覆號碼

輸出日誌範例

app id: *, app name: *, record id: *, comment id: [*]

回覆號碼將以逗號分隔輸出。

Record comment add

以下說明動作為[Record comment add]的監控日誌。

執行的操作

執行發表記錄回覆的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 記錄號碼
  • 回覆號碼

輸出日誌範例

app id: *, app name: *, record id: *, comment id: *

Record comment delete

以下說明動作為[Record comment delete]的監控日誌。

執行的操作

執行刪除記錄回覆的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 記錄號碼
  • 回覆號碼

輸出日誌範例

app id: *, app name: *, record id: *, comment id: *

Record assignees update

以下說明動作為[Record assignees update]的監控日誌。

執行的操作

執行更新記錄執行者的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 記錄號碼

輸出日誌範例

app id: *, app name: *, record id: *

Record status update

以下說明動作為[Record status update]的監控日誌。

執行的操作

執行變更記錄狀態的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 記錄號碼

輸出日誌範例

執行更新一筆記錄狀態的API
app id: *, app name: *, record id: *
執行更新多筆記錄狀態的API
app id: *, app name: *, record id: [*]

記錄號碼將以逗號分隔輸出。

Space add

以下說明動作為[Space add]的監控日誌。

執行的操作

執行建立空間的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • 空間ID
  • 空間名稱

輸出日誌範例

space id: *, space name: *

Space update

以下說明動作為[Space update]的監控日誌。

執行的操作

執行更新空間的設定的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • 空間ID
  • 空間名稱

輸出日誌範例

space id: *, space name: *

Space delete

以下說明動作為[Space delete]的監控日誌。

執行的操作

執行刪除空間的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • 空間ID
  • 空間名稱
  • アプリID
  • 應用程式名稱

輸出日誌範例

指定的空間ID不存在
space id: *
[Kintone系統管理]畫面的[功能的啟用]中[啟用空間功能]關閉
space id: *
空間內未配置應用程式
space id: *, space name: *
空間內有配置應用程式
space id: *, space name: *, (app id: *, app name: *), (...

Thread comment add

以下說明動作為[Thread comment add]的監控日誌。

執行的操作

執行對空間內主題發表回覆的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • 空間ID
  • 空間名稱
  • 主題ID
  • スレッドのタイトル
  • 回覆號碼

輸出日誌範例

space id: *, space name: *, thread id: *, thread name: *, comment id: *

Guests delete

以下說明動作為[Guests delete]的監控日誌。

執行的操作

執行刪除訪客的API。

層級

資訊

輸出至[補充]的內容

輸出刪除的訪客的電子郵件地址。

輸出日誌範例

guest user code: *

訪客的電子郵件地址將以逗號分隔輸出。

Record file download

以下說明動作為[Record file download]的監控日誌。

執行的操作

執行下載記錄附件的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 記錄號碼
  • 檔案名稱

輸出日誌範例

app id: *, app name: *, record id: *, filename: *

Webhook notify

以下說明動作為[Webhook notify]的監控日誌。

執行的操作

使用API傳送Webhook通知。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 記錄號碼
  • 通知ID
  • 事件類型
  • 收件伺服器的URL

通知成功時,輸出以下項目:

  • 通知的狀態碼

Kintone發生錯誤導致通知失敗時,輸出以下項目:

  • 錯誤類型:CLIENT_ERROR
  • 錯誤訊息

接收通知的Web服務發生錯誤導致通知失敗時,輸出以下項目:

  • 錯誤類型:SERVER_ERROR
  • 通知的HTTP狀態碼

輸出日誌範例

通知成功
app id: *, app name: *, record id: *, notification id: *, event type: [ADD_RECORD / ADD_RECORD_COMMENT / UPDATE_RECORD / UPDATE_STATUS], server url: *, status code: *
Kintone發生錯誤導致通知失敗
app id: *, app name: *, record id: *, notification id: *, event type: [ADD_RECORD / ADD_RECORD_COMMENT / UPDATE_RECORD / UPDATE_STATUS], server url: *, error type: CLIENT_ERROR, error message: *
接收通知的Web服務發生錯誤導致通知失敗
app id: *, app name: *, record id: *, notification id: *, event type: [ADD_RECORD / ADD_RECORD_COMMENT / UPDATE_RECORD / UPDATE_STATUS], server url: *, error type: SERVER_ERROR, status code: *

Send slack dm

以下說明動作為[Send slack dm]的監控日誌。

執行的操作

使用API傳送Slack通知。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 記錄號碼
  • 通知對象的Slack子網域
  • 目標使用者的登入名稱
  • 目標使用者的電子郵件地址

通知成功時,輸出以下項目:

  • Slack API的回應狀態碼

Kintone發生錯誤導致通知失敗時,輸出以下項目:

  • 錯誤類型:CLIENT_ERROR
  • 錯誤訊息

接收通知的Web服務發生錯誤導致通知失敗時,輸出以下項目:

  • 錯誤類型:SERVER_ERROR
  • 發生錯誤的Slack API的回應狀態碼
  • 錯誤訊息

輸出日誌範例

通知成功
app id: *, app name: *, record id: *, slack subdomain: *, user: *, Email: *, status code: *
Kintone發生錯誤導致通知失敗
app id: *, app name: *, record id: *, slack subdomain: *, user: *, Email: *, error type: CLIENT_ERROR, error message: *
接收通知的Web服務發生錯誤導致通知失敗
app id: *, app name: *, record id: *, slack subdomain: *, user: *, Email: *, error type: SERVER_ERROR, status code: *, error message: *

Plug-in installed

以下說明動作為[Plug-in installed]的監控日誌。

執行的操作

使用API在Kintone系統管理中匯入外掛程式。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • 外掛程式ID
  • プラグイン名

輸出日誌範例

plugin id: *, plugin name: *

Plug-in updated

以下說明動作為[Plug-in updated]的監控日誌。

執行的操作

使用API更新在Kintone系統管理中匯入的外掛程式。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • 外掛程式ID
  • プラグイン名

輸出日誌範例

plugin id: *, plugin name: *

Plug-in removed

以下說明動作為[Plug-in removed]的監控日誌。

執行的操作

使用API從Kintone系統管理中移除外掛程式。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • 外掛程式ID
  • プラグイン名

輸出日誌範例

plugin id: *, plugin name: *

App plugins add

以下說明動作為[App plugins add]的監控日誌。

執行的操作

執行在應用程式中新增外掛程式的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱

輸出日誌範例

app id: *, app name: *

Plugin config update

以下說明動作為[Plugin config update]的監控日誌。

執行的操作

執行變更已新增到應用程式中的外掛程式設定資訊的API。

層級

資訊

輸出至[補充]的內容

輸出以下項目:

  • アプリID
  • 應用程式名稱
  • 外掛程式ID

輸出日誌範例

app id: *, app name: *, plugin id: *

屬性

輸出到監控日誌[補充]欄的屬性如下:

actions

應用程式動作清單。

app id

應用程式的ID。

app name

應用程式的名稱。

comment id

回覆號碼。

Email

電子郵件地址。

enableBulkDeletion

[進階設定]畫面中[大量刪除]的設定值。
狀態為以下其中之一:

  • 啟用:true
  • 停用:false

enableComments

[進階設定]畫面中[記錄的回覆]的設定值。
狀態為以下其中之一:

  • 啟用:true
  • 停用:false

enableDuplicateRecord

[進階設定]畫面中[重複利用記錄]的設定值。
狀態為以下其中之一:

  • 啟用:true
  • 停用:false

enableThumbnails

[進階設定]畫面中[圖片]的設定值。
狀態為以下其中之一:

  • 啟用:true
  • 停用:false

error message

錯誤訊息。

error type

錯誤類型。輸出以下錯誤類型:

  • CLIENT_ERROR:Kintone發生錯誤導致失敗時輸出。
  • SERVER_ERROR:接收通知的Web服務發生錯誤導致失敗時輸出。

event type

事件類型。輸出以下事件類型:

  • ADD_RECORD:新增記錄
  • ADD_RECORD_COMMENT:新增記錄回覆
  • UPDATE_RECORD:更新記錄
  • UPDATE_STATUS:更新狀態
  • DELETE_RECORD:刪除記錄

field code

欄位代碼。

field

欄位代碼。

filename

檔案名稱。

firstMonthOfFiscalYear

[進階設定]畫面中[第一季度的開始月份]的設定值。

guest user code

訪客的電子郵件地址。

inserted record id

新增的記錄號碼。

notification id

通知ID。

numberPrecision digits

[進階設定]畫面中[數值和計算的精準度]的[總位數]的設定值。

numberPrecision decimalPlaces

[進階設定]畫面中[數值和計算的精準度]的[小數位數]的設定值。

numberPrecision roundingMode

輸出[進階設定]畫面中[數值和計算的精準度]的[進位方式]的設定狀態。

  • [四捨五入為最相近的偶數]:HALF_EVEN
  • [無條件進位]:UP
  • [無條件捨去]:DOWN

operation

更新多筆記錄時指定的操作模式。

plugin id

外掛程式ID。

plugin name

外掛程式名稱。

preview

為測試環境時輸出。

record id

記錄號碼。

record key

欄位代碼及指定值的清單。

reports

圖表名稱的清單。

revert

輸出是否取消變更應用程式的設定。

  • true:取消變更應用程式的設定。
  • false:將變更應用程式的設定套用至正式環境。

server url

伺服器URL。

slack subdomain

Slack子網域。

slack workspace

[Slack整合]畫面中設定為整合對象的Slack的URL。

space id

空間ID。

space name

應用程式的名稱。

status code

狀態碼。

status

狀態的清單。

target

輸出在[應用程式的設定]中變更的部分。

thread id

主題ID。

thread name

主題名稱。

titleField selectionMode

輸出[記錄標題]畫面中[作為記錄標題的欄位]的設定狀態。

  • AUTO:[作為記錄標題的欄位]的設定中選擇[使用自動設定]
  • MANUAL:[作為記錄標題的欄位]的設定中選擇[選擇欄位]

titleField code

[記錄標題]畫面中指定為[作為記錄標題的欄位]的欄位代碼。

updated record id

更新的記錄ID。

user

登入名稱。

value

指定值。

views

清單一覽。