使用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
  • 应用名称
更改了“记录标题”的设置时

输出以下项目。

  • 应用ID
  • 应用名称
  • 已更改的设置项目的状态

设置项目的状态属于以下任意一种情况。

  • 在“用于记录标题的字段”的设置中选择“使用自动设置”时：AUTO
  • 在“用于记录标题的字段”的设置中选择“选择字段”时：MANUAL

选择“选择字段”时，也将输出“用于记录标题的字段”的字段代码。

更改了“高级设置”的设置时

输出以下项目。

  • 应用ID
  • 应用名称
  • 已更改的设置项目和状态

已更改的设置项目输出如下。

  • 显示缩略图（enableThumbnail）
  • 批量删除记录功能（enableBulkDeletion）
  • 记录的回复功能（enableComments）
  • 记录的重复利用功能（enableDuplicateRecord）
  • 数值和计算的精度的设置
  • 第一季度的开始月份的设置

已更改的设置项目的状态属于以下任意一种情况。

  • 启用：true
  • 禁用：false

数值和计算的精度设置将输出以下的值。

  • 已设置为总位数的值（numberPrecision digits）
  • 已设置为小数位的位数的值（numberPrecision places）
  • 舍入方法（numberPrecision roundingMode）
    • 四舍六入五留双：HALF_EVEN
    • 向上舍入：UP
    • 向下舍入：DOWN

第一季度的开始月份设置将输出已设置的值（firstMonthOfFiscalYear）。

输出的日志示例

更改了“常规设置”的设置时
app id: *, app name: *
更改了“记录标题”的设置时
app id: *, app name: *, titleField selectionMode: {AUTO/MANUAL}, titleField code: *
更改了“高级设置”中缩略图显示的设置时
app id: *, app name: *, enableThumbnail: {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: *, numberPrecision digits: *, numberPrecision places: *, 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: [*]

动作列表以逗号分隔的方式输出。

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。

等级

信息

输出到“补充”中的内容

输出以下项目。

  • 应用ID
  • 应用名称
  • 记录编号（指定记录编号进行更新时）
  • 字段代码（指定字段代码和值进行更新时）
  • 指定的值（指定字段代码和值进行更新时）

输出的日志示例

指定记录编号，执行更新1条记录的API时
app id: *, app name: *, record id: *
指定字段代码，执行更新1条记录的API时
app id: *, app name: *, field: *, value: *
执行更新若干条记录的API时
app id: *, app name: *, record id: [*], record key: [[field: *, value: *]]

记录编号、字段代码、指定的值以逗号分隔的方式输出。
记录编号和记录Key为空时输出“[]”。

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 delete

以下说明动作为“Space delete”的监控日志。

执行的操作

执行删除空间的API。

等级

信息

输出到“补充”中的内容

输出以下项目。

  • 空间ID
  • 空间名称
  • 应用ID
  • 应用名称

输出的日志示例

指定的空间ID不存在时
space id: *
系统管理页面的“功能的启用”中未勾选“启用空间功能”时
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: *

属性

输出到监控日志的“补充”栏中的属性如下。

actions

应用分享的列表。

app id

应用的ID。

app name

应用名称。

comment id

回复编号。

Email

邮件地址。

enableBulkDeletion

记录的批量删除功能的设置值。
状态属于以下任意一种情况。

  • 启用：true
  • 禁用：false

enableComments

记录的回复功能的设置值。
状态属于以下任意一种情况。

  • 启用：true
  • 禁用：false

enableDuplicateRecord

记录的重复利用设置的设置值。

  • 启用：true
  • 禁用：false

enableThumbnail

显示缩略图功能的设置值。 状态属于以下任意一种情况。

  • 启用：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

来宾的邮件地址。

notification id

通知ID。

numberPrecision digits

已设置为总位数的值。

numberPrecision places

已设置为小数位的位数的值。

numberPrecision roundingMode

输出小数位舍入方法的设置状态。

  • 四舍六入五留双：HALF_EVEN
  • 向上舍入：UP
  • 向下舍入：DOWN

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

状态列表。

thread id

主题ID。

thread name

主题名称。

titleField selectionMode

输出用于记录标题的字段的设置状态。

  • AUTO：在“用于记录标题的字段”的设置中选择了“使用自动设置”
  • MANUAL：在“用于记录标题的字段”的设置中选择了“选择字段”

titleField code

被指定作为记录标题的字段的字段代码。

user

登录名称。

value

指定的值。

views

列表清单。