获取应用的使用情况

aki发表于:2024年09月18日 16:10:14更新于:2024年09月24日 10:03:40

此 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字符串应用状态
将返回以下信息之一
  • CHANGED

  • NOT_ACTIVATED

  • ACTIVATED

apps[].recordUpdatedAt字符串最后添加或编辑记录的日期
对于 2021 年 1 月系统升级前创建的应用程序,如果此后没有添加或编辑过记录,则会返回应用的创建日期。
apps[].recordCount数值或字符串应用程序中的记录数
apps[].fieldCount数值或字符串应用程序中的字段数量
apps[].dailyRequestCount数值或字符串每天的API请求数
apps[].storageUsage数值或字符串附件字段中所附文件的总大小
单位为Byte。
apps[].customized布尔值是否对应用进行自定义
如果符合以下情况,则返回 "true"。
  • 使用 JavaScript / CSS 进行自定义

  • 使用插件进行自定义

  • 存在 "自定义 "格式的列表

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);