获取已安装的插件列表

aki发表于:2024年06月26日 13:38:11更新于:2024年07月10日 15:18:38

获取已安装到 kintone 的插件列表。

URL

https://(子域名).cybozu.cn/k/v1/plugins.json

HTTP 方法

GET

所需访问权限

请求

参数

参数名称类型必须说明
offset数值或字符串可省略从列表开头起要跳过的数量。
若省略,则设置为 0。
limit数值或字符串可省略可获取的插件数量上限。
可指定 1 到 100 之间的数字。
若省略,则设置为 100。

请求示例(当URL中包含参数时)

URL

https://(子域名).cybozu.cn/k/v1/plugins.json?offset=1&limit=1

头部
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

有关请求头部的更多信息,请参考共通规格。
kintone REST API 的共通规格

请求示例(当请求正文包含参数时)

URL

https://(子域名).cybozu.cn/k/v1/plugins.json

头部
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

有关请求头部的更多信息,请参考共通规格。
kintone REST API 的共通规格

正文

{
  "offset": 0,
  "limit": 1
}

应答

属性

属性名称类型说明
plugins数组(对象)已安装的插件列表

按安装日期和时间的降序排列。
若插件不存在,则返回空数组。

plugins[].id字符串插件 ID
plugins[].name字符串插件名称
plugins[].isMarketPlugin布尔值是否是插件商城中的插件
  • true:是插件商城中的插件

  • false插件:不是插件商城中的插件

plugins[].version字符串插件版本

响应范例

{
  "plugins": [
    {
      "id": "djmhffjhfgmebgnmcggopedaofckljlj",
      "name": "插件范例",
      "isMarketPlugin": false,
      "version": "1.0.0"
    }
  ]
}

示例代码

使用 curl 发送请求

curl -X GET 'https://(子域名).cybozu.cn/k/v1/plugins.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "limit": 1
  }'

使用kintone.api()发送请求

kintone.api()的详情请参考以下文章。
发送 kintone REST API 请求

const body = {
  limit: 1,
};

await kintone.api(kintone.api.url('/k/v1/plugins.json', true), 'GET', body);