APIを使用した操作
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
- アプリ名
- レコード番号
出力されるログの例
1件のレコードを登録するAPIを使用した場合
app id: *, app name: *, record id: *
複数のレコードを登録するAPIを使用した場合
app id: *, app name: *, record id: [*]
レコード番号はカンマ区切りで出力されます。
Record update
アクションが「Record update」である監査ログについて説明します。
実行された操作
レコードを更新するAPIを実行した。
レベル
情報
「補足」に出力される内容
1件のレコードを更新するAPIを使用した場合
次の項目が出力されます。
- アプリID
- アプリ名
- レコード番号(レコード番号を指定して更新した場合)
- フィールドコード(フィールドコードと値を指定して更新した場合)
- 指定した値(フィールドコードと値を指定して更新した場合)
複数のレコードを更新するAPIを使用した場合
次の項目が出力されます。
UPSERTモードを無効にして実行した場合
- オペレーション
- アプリID
- アプリ名
- レコードID(レコード番号を指定して更新したとき)
- フィールドコード(フィールドコードと値を指定して更新したとき)
- 指定した値(フィールドコードと値を指定して更新したとき)
UPSERTモードを有効にして実行した場合
- オペレーション
- アプリID
- アプリ名
- 新規に追加されたレコードID
- 更新されたレコードID
出力されるログの例
1件のレコードを更新するAPI
レコード番号を指定して実行した場合
app id: *, app name: *, record id: *
フィールドコードと値を指定して実行した場合
app id: *, app name: *, field: *, value: *
複数のレコードを更新するAPI
レコード番号、フィールドコード、指定した値はカンマ区切りで出力されます。
レコード番号とレコードキーは、空の場合「[]」と出力されます。
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
- アプリ名
- レコード番号
出力されるログの例
1件のレコードのステータスを更新する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
コメント番号です。
メールアドレスです。
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
一覧のリストです。