获取已添加到应用的插件列表。
URL
获取正式环境设置时的URL与获取测试环境设置的URL不同。
获取正式环境设置
常规应用
https://(子域名).cybozu.cn/k/v1/app/plugins.json
来宾空间应用
https://(子域名).cybozu.cn/k/guest/
来宾空间ID/v1/app/plugins.json
获取测试环境的设置
常规应用
https://(子域名).cybozu.cn/k/v1/preview/app/plugins.json
来宾空间应用
https://(子域名).cybozu.cn/k/guest/
来宾空间ID/v1/preview/app/plugins.json
HTTP 方法
GET
所需访问权限
应用管理权限
请求
参数
| 参数名称 | 类型 | 必须 | 说明 |
|---|---|---|---|
| app | 数值或字符串 | 必须 | 应用ID |
| lang | 字符串 | 可省略 | 要获取的插件名称的区域。 kintone 插件的开发流程｜可指定的区域
若语言设置为 "与Web浏览器的设置相同"，则根据是否设置有“Accept-Language”标头来决定显示语言。
|
请求范例
头部
{
"X-Cybozu-API-Token": "API_TOKEN",
"Content-Type": "application/json"
}有关请求头部的更多信息，请参考以下文章。
kintone REST API 的共通规格
正文
{
"app": 1,
"lang": "ja"
}应答
属性
| 属性名称 | 类型 | 说明 |
|---|---|---|
| plugins | 数组（对象） | 应用中已添加的插件信息 |
| plugins[].id | 字符串 | 插件 ID |
| plugins[].name | 字符串 | 插件名称 |
| plugins[].enabled | 布尔值 | 是否启用插件
|
| revision | 字符串 | 应用设置的版本号 |
响应范例
{
"plugins": [
{
"id": "djmhffjhfgmebgnmcggopedaofckljlj",
"name": "插件名称"，
"enabled": true
}
],
"revision": "2"
}示例代码
使用 curl 发送请求
curl -X GET 'https://(子域名).cybozu.cn/k/v1/app/plugins.json' \
-H 'X-Cybozu-API-Token: "API_TOKEN"' \
-H 'Content-Type: application/json' \
-d '{
"app": 1,
"lang": "zh"
}'使用kintone.api()发送请求
kintone.api()的详情请参考以下文章。
发送 kintone REST API 请求的API
const body = {
app: 1,
lang: 'zh'
};
await kintone.api(kintone.api.url('/k/v1/app/plugins.json', true), 'GET', body);