Actions Performed via API

Article Number:040820

This article describes the audit logs that are generated when actions are performed via API.

Module: "API operation"

Audit logs with the module "API operation" are shown below.

Action: "App create"

This section describes audit logs with the action "App create".

An audit log is generated when:

The API to create a preview app is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name

Example of a generated log

app id: *, app name: *

Action: "App deploy"

This section describes audit logs with the action "App deploy".

An audit log is generated when:

The API to update the settings of pre-live apps to live apps is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App IDs
  • Whether the changes made to pre-live settings were canceled
    • If the changes were canceled: true
    • If the changes were deployed to live apps: false

Example of a generated log

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

App IDs are separated by commas.

Action: "App update"

This section describes audit logs with the action "App update".

An audit log is generated when:

An API is executed to update any of the following settings of a pre-live app.

  • Notes for App Administrators in App Settings
  • General Settings in App Settings
  • Title Field in App Settings
  • Show Thumbnails under Misc Settings in App Settings
  • Bulk Deletion under Misc Settings in App Settings
  • Comments under Misc Settings in App Settings
  • Duplicate Record under Misc Settings in App Settings
  • Precision of Numbers and Calculations under Misc Settings in App Settings
  • First Month of Fiscal Year under Misc Settings in App Settings

Level

Information

Information displayed in the "Complement" section

When Notes for App Administrators is updated

The following information is displayed:

  • App ID
  • App name
  • Changed settings ("target")

"settingsNotes"is displayed for the changed settings.

When settings in General Settings are updated

The following information is displayed:

  • App ID
  • App name
When the Title Field settings are updated

The following information is displayed:

  • App ID
  • App name
  • State of the updated setting

One of the following states is displayed.

  • If Set automatically is selected for The field to be used as the record title: AUTO
  • If Set manually is selected for The field to be used as the record title: MANUAL

If Set manually is selected, the field code of the field to be used as the record title is also displayed.

When settings in Misc Settings are updated

The following information is displayed:

  • App ID
  • App name
  • Changed settings and their enabled/disabled states

The following changed settings are displayed.

  • Show Thumbnails (enableThumbnail)
  • Bulk Deletion (enableBulkDeletion)
  • Comments (enableComments)
  • Duplicate Record (enableDuplicateRecord)
  • Precision of Numbers and Calculations
  • First Month of Fiscal Year

The following states are displayed for changed settings.

  • If the setting was enabled: true
  • If the setting was disabled: false

The following values are displayed for the Precision of Numbers and Calculations settings.

  • The value specified for Total Number of Digits (numberPrecision digits)
  • The value specified for Number of Decimal Places to Round (numberPrecision places)
  • The method specified for Rounding (numberPrecision roundingMode)
    • Round to nearest even number: HALF_EVEN
    • Round up: UP
    • Round down: DOWN

For the First Month of Fiscal Year setting, the selected value (firstMonthOfFiscalYear) is displayed.

Examples of generated logs

When Notes for App Administrators is updated
app id: *, app name: *, target: settingsNotes
When settings in General Settings are updated
app id: *, app name: *
When the Title Field settings are updated
app id: *, app name: *, titleField selectionMode: {AUTO/MANUAL}, titleField code: *
When the Show Thumbnails setting in Misc Settings is updated
app id: *, app name: *, enableThumbnail: {true/false}
When the Bulk Deletion setting in Misc Settings is updated
app id: *, app name: *, enableBulkDeletion: {true/false}
When the Comments setting in Misc Settings is updated
app id: *, app name: *, enableComments: {true/false}
When the Duplicate Record setting in Misc Settings is updated
app id: *, app name: *, enableDuplicateRecord: {true/false}
When the Precision of Numbers and Calculations setting in Misc Settings is updated
app id: *, app name: *, numberPrecision digits: *, numberPrecision places: *, numberPrecision roundingMode: {HALF_EVEN/UP/DOWN}
When the First Month of Fiscal Year setting in Misc Settings is updated
app id: *, app name: *, firstMonthOfFiscalYear: *

Action: "App status update"

This section describes audit logs with the action "App status update".

An audit log is generated when:

The API to update the Process Management settings of a pre-live app is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • The enabled/disabled state of the Process Management feature
  • List of status names after the update
  • List of action names after the update

The list of status names and the list of action names are specified in the default language.

Example of a generated log

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

Action: "App customize update"

This section describes audit logs with the action "App customize update".

An audit log is generated when:

The API to update the JavaScript and CSS Customization settings of a pre-live app is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name

Example of a generated log

app id: *, app name: *

Action: "Notification update"

This section describes audit logs with the action "Notification update".

An audit log is generated when:

The API to update the General Notifications, Per Record Notifications, or Reminder Notifications settings of a pre-live app is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name

Example of a generated log

app id: *, app name: *

Action: "App permission update"

This section describes audit logs with the action "App permission update".

An audit log is generated when:

The API to update the Permissions for App settings is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • "preview" if the API was used for a pre-live app

Examples of generated logs

If the API is used for a live app
app id: *, app name: *
If the API is used for a pre-live app
app id: *, app name: *, preview

Action: "Record permission update"

This section describes audit logs with the action "Record permission update".

An audit log is generated when:

The API to update the Permissions for Records settings is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • "preview" if the API was used for a pre-live app

Examples of generated logs

If the API is used for a live app
app id: *, app name: *
If the API is used for a pre-live app
app id: *, app name: *, preview

Action: "Field permission update"

This section describes audit logs with the action "Field permission update".

An audit log is generated when:

The API to update the Permissions for Fields settings is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • "preview" if the API was used for a pre-live app

Examples of generated logs

If the API is used for a live app
app id: *, app name: *
If the API is used for a pre-live app
app id: *, app name: *, preview

Action: "App action update"

This section describes audit logs with the action "App action update".

An audit log is generated when:

The API to update the Actions settings of a pre-live app is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • List of actions that exist after the update

Example of a generated log

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

Actions are separated by commas.

Action: "App category update"

This section describes audit logs with the action "App category update".

An audit log is generated when:

The API to update the Categories settings of an app is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name

Example of a generated log

app id: *, app name: *

Action: "App move started"

This section describes audit logs with the action "App move started".

An audit log is generated when:

The API to change the space to which an app belongs is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • Source space ID
  • Destination space ID

Example of a generated log

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

Action: "Form update"

This section describes audit logs with the action "Form update".

An audit log is generated when:

One of the following APIs is executed on a pre-live app.

  • The API to add fields on the app form
  • The API to update the field settings of fields
  • The API to delete fields from the app form
  • The API to update the field layout information of the app form

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • Field codes of the fields that were added, updated, or deleted

Examples of generated logs

If fields are added, updated, or deleted
app id: *, app name: *, field code: [*]

Field codes are separated by commas.

If the field layout information of the app form is updated
app id: *, app name: *

Action: "App view update"

This section describes audit logs with the action "App view update".

An audit log is generated when:

The API to update the View settings of a pre-live app is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • List of views that exist after the update

Example of a generated log

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

Views are separated by commas.

Action: "App report update"

This section describes audit logs with the action "App report update".

An audit log is generated when:

The API to update the Graph settings of a pre-live app is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • List of graphs that exist after the update

Example of a generated log

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

Graph names are separated by commas.

Action: "Record add"

This section describes audit logs with the action "Record add".

An audit log is generated when:

The API to add records to an app is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • Record number

Examples of generated logs

If the Add Record API is executed
app id: *, app name: *, record id: *
If the Add Records API is executed
app id: *, app name: *, record id: [*]

Record numbers are separated by commas.

Action: "Record update"

This section describes audit logs with the action "Record update".

An audit log is generated when:

The API to update records in an app is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • Record numbers (If records were updated by specifying the record numbers)
  • Field code (If records were updated by specifying a field code and a value)
  • Field value (If records were updated by specifying a field code and a value)

Examples of generated logs

If the Update Record API is executed with a record number specified
app id: *, app name: *, record id: *
If the Update Record API is executed with a field code and a value specified
app id: *, app name: *, field: *, value: *
If the Update Records API is executed
app id: *, app name: *, record id: [*], record key: [[field: *, value: *]]

Record numbers, field codes, and specified values are separated by commas.
If record numbers and record keys are empty, the audit log displays "[]" for these two items.

Action: "Record delete"

This section describes audit logs with the action "Record delete".

An audit log is generated when:

The API to delete records in an app is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • Record number

Example of a generated log

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

Record numbers are separated by commas.

Action: "Cursor create"

This section describes audit logs with the action "Cursor create".

An audit log is generated when:

The API to add a cursor for obtaining records in bulk is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name

Example of a generated log

app id: *, app name: *

Action: "Record comment get"

This section describes audit logs with the action "Record comment get".

An audit log is generated when:

The API to retrieve comments from a record is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • Record number
  • Comment number

Example of a generated log

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

Comment numbers are separated by commas.

Action: "Record comment add"

This section describes audit logs with the action "Record comment add".

An audit log is generated when:

The API to add a comment to a record is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • Record number
  • Comment number

Example of a generated log

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

Action: "Record comment delete"

This section describes audit logs with the action "Record comment delete".

An audit log is generated when:

The API to delete a comment in a record is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • Record number
  • Comment number

Example of a generated log

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

Action: "Record assignees update"

This section describes audit logs with the action "Record assignees update".

An audit log is generated when:

The API to update process management assignees of a record is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • Record number

Example of a generated log

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

Action: "Record status update"

This section describes audit logs with the action "Record status update".

An audit log is generated when:

The API to update process management statuses of records is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • Record number

Examples of generated logs

If the Update Status API is executed
app id: *, app name: *, record id: *
If the Update Statuses API is executed
app id: *, app name: *, record id: [*]

Record numbers are separated by commas.

Action: "Space delete"

This section describes audit logs with the action "Space delete".

An audit log is generated when:

The API to delete a space is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • Space ID
  • Space name
  • App ID
  • App name

Examples of generated logs

If the specified space ID does not exist
space id: *
If "Activate Spaces" in the Feature Activation settings in Kintone Administration is disabled
space id: *
If the space does not have any in-space apps
space id: *, space name: *
If the space has one or more in-space apps
space id: *, space name: *, (app id: *, app name: *), (...

Action: "Thread comment add"

This section describes audit logs with the action "Thread comment add".

An audit log is generated when:

The API to add a comment to a thread of a space is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • Space ID
  • Space name
  • Thread ID
  • Thread name
  • Comment number

Example of a generated log

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

Action: "Guests delete"

This section describes audit logs with the action "Guests delete".

An audit log is generated when:

The API to delete guest users is executed.

Level

Information

Information displayed in the "Complement" section

The e-mail addresses of the deleted guest users are displayed.

Example of a generated log

guest user code: *

The e-mail addresses are separated by commas.

Action: "Record file download"

This section describes audit logs with the action "Record file download".

An audit log is generated when:

The API to download files from an "Attachment" field is executed.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • Record number
  • File name

Example of a generated log

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

Action: "Webhook notify"

This section describes audit logs with the action "Webhook notify".

An audit log is generated when:

A Webhook notification is sent via API.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • Record number
  • Notification ID
  • Event type
  • Destination server URL

If the notification is successfully sent, the following information is displayed.

  • Status code of the notification

If the notification cannot be sent due to an error attributable to Kintone, the following information is displayed.

  • Error type: CLIENT_ERROR
  • Error message

If the notification cannot be sent due to an error attributable to the web service that receives the notification, the following information is displayed.

  • Error type: SERVER_ERROR
  • HTTP status code of the notification

Examples of generated logs

If the notification is successfully sent
app id: *, app name: *, record id: *, notification id: *, event type: [ADD_RECORD / ADD_RECORD_COMMENT / UPDATE_RECORD / UPDATE_STATUS], server url: *, status code: *
If the notification cannot be sent due to an error attributable to 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: *
If the notification cannot be sent due to an error attributable to the web service that receives the notification
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: *

Action: "Send slack dm"

This section describes audit logs with the action "Send slack dm".

An audit log is generated when:

A Slack notification is sent via API.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • App ID
  • App name
  • Record number
  • Slack subdomain where the notification was sent
  • Login name of the user to whom the notification was sent
  • E-mail address of the user to whom the notification was sent

If the notification is successfully sent, the following information is displayed.

  • Response status code from Slack API

If the notification cannot be sent due to an error attributable to Kintone, the following information is displayed.

  • Error type: CLIENT_ERROR
  • Error message

If the notification cannot be sent due to an error attributable to the web service that receives the notification, the following information is displayed.

  • Error type: SERVER_ERROR
  • Response status code from the failed Slack API
  • Error message

Examples of generated logs

If the notification is successfully sent
app id: *, app name: *, record id: *, slack subdomain: *, user: *, Email: *, status code: *
If the notification cannot be sent due to an error attributable to Kintone
app id: *, app name: *, record id: *, slack subdomain: *, user: *, Email: *, error type: CLIENT_ERROR, error message: *
If the notification cannot be sent due to an error attributable to the web service that receives the notification
app id: *, app name: *, record id: *, slack subdomain: *, user: *, Email: *, error type: SERVER_ERROR, status code: *, error message: *

Action: "Plug-in installed"

This section describes audit logs with the action "Plug-in installed".

An audit log is generated when:

An API is used to add a plug-in to Kintone Administration.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • Plug-in ID
  • Plug-in name

Example of a generated log

plugin id: *, plugin name: *

Action: "Plug-in updated"

This section describes audit logs with the action "Plug-in updated".

An audit log is generated when:

An API is used to update a plug-in installed in Kintone Administration.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • Plug-in ID
  • Plug-in name

Example of a generated log

plugin id: *, plugin name: *

Action: "Plug-in removed"

This section describes audit logs with the action "Plug-in removed".

An audit log is generated when:

An API is used to remove a plug-in from Kintone Administration.

Level

Information

Information displayed in the "Complement" section

The following information is displayed:

  • Plug-in ID
  • Plug-in name

Example of a generated log

plugin id: *, plugin name: *

Properties

The properties displayed in the Complement section of the audit log details are as follows.

"actions"

Indicates app actions.

"app id"

Indicates app IDs.

"app name"

Indicates app names.

"comment id"

Indicates comment numbers.

"Email"

Indicates e-mail addresses.

"enableBulkDeletion"

Indicates the value specified for the Bulk Deletion setting.
Either of the following is displayed.

  • If the setting was enabled: true
  • If the setting was disabled: false

"enableComments"

Indicates the value specified for the Comments setting.
Either of the following is displayed.

  • If the setting was enabled: true
  • If the setting was disabled: false

"enableDuplicateRecord"

Indicates the value specified for the Duplicate Record setting.

  • If the setting was enabled: true
  • If the setting was disabled: false

"enableThumbnail"

Indicates the value specified for the Show Thumbnails setting. Either of the following is displayed as the state.

  • If the setting was enabled: true
  • If the setting was disabled: false

"error message"

Indicates error messages.

"error type"

Indicates error types. The following error types are displayed.

  • CLIENT_ERROR: Indicates that the action failed due to an error attributable to Kintone.
  • SERVER_ERROR: Indicates that the action failed due to an error attributable to the web service that receives the notification.

"event type"

Indicates event types. The following event types are displayed.

  • ADD_RECORD: Indicates that a record was added.
  • ADD_RECORD_COMMENT: Indicates that a comment was posted.
  • UPDATE_RECORD: Indicates that a record was updated.
  • UPDATE_STATUS: Indicates that a status was changed.
  • DELETE_RECORD: Indicates that a record was deleted.

"field code"

Indicates field codes.

"field"

Indicates field codes.

"filename"

Indicates file names.

"firstMonthOfFiscalYear"

Indicates the value specified for the First Month of Fiscal Year setting.

"guest user code"

Indicates the e-mail addresses of guest users.

"notification id"

Indicates notification IDs.

"numberPrecision digits"

Indicates the value specified for the Total Number of Digits setting.

"numberPrecision places"

Indicates the value specified for the Number of Decimal Places to Round setting.

"numberPrecision roundingMode"

One of the following states is displayed depending on the method specified for the Rounding setting.

  • Round to nearest even number: HALF_EVEN
  • Round up: UP
  • Round down: DOWN

plugin id

Indicates plug-in IDs.

"plugin name"

Indicates plug-in names.

"preview"

Indicates that the relevant API was executed on a pre-live app.

"record id"

Indicates record numbers.

"record key"

Indicates field codes and specified values.

"reports"

Indicates graphs.

"revert"

Indicates whether the changes made to pre-live App Settings were canceled.

  • true: Indicates that the changes were canceled.
  • false: Indicates that the changes were deployed to live apps.

"server url"

Indicates server URLs.

"slack subdomain"

Indicates Slack subdomains.

"slack workspace"

Indicates the Slack URL to which slack notifications are set to be sent via Slack integration.

"space id"

Indicates space IDs.

"space name"

Indicates space names.

"status code"

Indicates status codes.

"status"

Indicates statuses.

"target"

Indicates the changed settings in App Settings.

"thread id"

Indicates thread IDs.

"thread name"

Indicates thread names.

"titleField selectionMode"

Indicates the state of the field to be used as the record title in the Title Field settings.

  • AUTO: Set automatically is selected for The field to be used as the record title.
  • MANUAL: Set manually is selected for The field to be used as the record title.

"titleField code"

Indicates the field code of the field specified as the Title Field.

"user"

Indicates login names.

"value"

Indicates specified values.

"views"

Indicates views.