为应用添加插件

aki发表于:2024年06月26日 13:03:02更新于:2024年07月10日 14:38:28

为应用添加插件。

URL

常规应用

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

来宾空间应用

  • https://(子域名).cybozu.cn/k/guest/来宾空间ID/v1/preview/app/plugins.json

HTTP 方法

POST

所需访问权限

  • 应用管理权限

请求

参数

参数名称类型必须说明
app数值或字符串必须应用ID
ids数组(字符串)必须

要添加的插件 ID

可指定kintone系统管理已导入的插件。

revision数值或字符串可省略预计修订后的版本号
若版本号与实际版本号不符,则会出错且不会更改设置。
若指定值为"-1"或未指定,则不验证版本号。

请求范例

头部
{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

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

正文
{
  "app": 2,
  "ids": ["djmhffjhfgmebgnmcggopedaofckljlj"]
}

应答

属性

属性名称类型说明
revision字符串更改应用设置后的版本号

响应范例

{
  "version": "2"
}

示例代码

使用 curl 发送请求

curl -X POST 'https://(子域名).cybozu.cn/k/v1/plugin.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": "2",
    "ids": ["djmhffjhfgmebgnmcggopedaofckljlj"]
  }'

使用kintone.api()发送请求

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

const body = {
  app: kintone.app.getId(),
  ids: ['djmhffjhfgmebgnmcggopedaofckljlj']
};

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

参考