此 API 为拓展版(Wide Course)专用。
什么是拓展版? (日语)
获取应用的使用情况
获取具有应用管理权限的应用使用情况列表。
一次可获取的应用数量上限为 100 个。
URL
https://sample.cybozu.com/k/v1/apps/statistics.json
HTTP 方法
GET
所需访问权限
应用管理权限
请求
参数
参数名称 | 类型 | 必须 | 说明 |
---|---|---|---|
offset | 数值或字符串 | 可省略 | 从列表开头起要跳过的数量。 如果省略,则设置为 0。 |
limit | 数值或字符串 | 可省略 | 要获取的条数 可指定 1 到 100 之间的数字。 如果省略,则设置为 100。 |
请求示例(在 URL 中添加参数的情况)
URL
https://sample.cybozu.com/k/v1/apps/statistics.json?offset=1&limit=1
头部
{ "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=" }
有关请求标头的更多信息,请参考共通规格。
kintone REST API 的共通规格
请求示例(在请求正文添加参数的情况)
URL
https://sample.cybozu.com/k/v1/apps/statistics.json
头部
{ "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=", "Content-Type": "application/json" }
有关请求标头的更多信息,请参考共通规格。
kintone REST API 的共通规格
正文
{ "offset": 0, "limit": 1 }
应答
属性
属性名称 | 类型 | 说明 |
---|---|---|
apps | 数组 | 应用信息列表 |
apps[].id | 数值或字符串 | 应用ID |
apps[].name | 字符串 | 应用名称 如果为每种语言设置了应用名称,则将根据执行 API 的用户设置的语言返回应用名称。 |
apps[].space | 对象 | 所属空间的信息 对于不属于空间的应用,将返回 "null"。 |
apps[].space.id | 数值或字符串 | 空间 ID |
apps[].space.name | 字符串 | 空间名 |
apps[].appGroup | 字符串 | 应用组 |
apps[].status | 字符串 | 应用状态 将返回以下信息之一
|
apps[].recordUpdatedAt | 字符串 | 最后添加或编辑记录的日期 对于 2021 年 1 月系统升级前创建的应用程序,如果此后没有添加或编辑过记录,则会返回应用的创建日期。 |
apps[].recordCount | 数值或字符串 | 应用程序中的记录数 |
apps[].fieldCount | 数值或字符串 | 应用程序中的字段数量 |
apps[].dailyRequestCount | 数值或字符串 | 每天的API请求数 |
apps[].storageUsage | 数值或字符串 | 附件字段中所附文件的总大小 单位为Byte。 |
apps[].customized | 布尔值 | 是否对应用进行自定义 如果符合以下情况,则返回 "true"。
|
apps[].creator | 对象 | 创建人信息 |
apps[].creator.code | 字符串 | 创建人的登录名 即使是被暂停/删除的用户,也可以获取。 |
apps[].creator.name | 字符串 | 创建人的显示名称 即使是被暂停/删除的用户,也可以获取。 |
apps[].createdAt | 字符串 | 创建时间 |
apps[].modifier | 对象 | 应用设置的最后更新人的信息 |
apps[].modifier.code | 字符串 | 更新人的登录名 即使是被暂停/删除的用户,也可以获取。 |
apps[].modifier.name | 字符串 | 更新人的显示名称 即使是被暂停/删除的用户,也可以获取。 |
apps[].modifiedAt | 字符串 | 上次更新应用程序设置的日期和时间。 |
响应范例
{ apps [ { "id": "2", "name":"案件管理" "space" : { "id": "2", "name": "销售管理" }, "appGroup": "Public", "status": "ACTIVATED", "recordUpdatedAt": "2023-12-04T05:45:36.000Z", "recordCount":"100", "fieldCount":"2", "dailyRequestCount":"2", "storageUsage":"47000000", "customized":true, "creator" : { "code": "tanaka", "name": "tanaka" }, "createdAt": "2023-12-04T05:45:36.000Z", "modifier" : { "code": "tanaka", "name": "tanaka" }, "modifiedAt": "2023-12-04T05:45:36.000Z" } ] }
代码范例
使用 curl 发送请求
curl -X GET 'https://sample.cybozu.cn/k/v1/apps/statistics.json' \ -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \ -H 'Content-Type: application/json' \ -d '{ limit 1 }'
使用发送 kintone REST API 请求的API发送请求
const body = { limit: 1 }; await kintone.api(kintone.api.url('/k/v1/apps/statistics.json', true), 'GET', body);