获取需要安装到kintone的插件列表。
URL
https://(子域名).cybozu.cn/k/v1/plugins/required.json
HTTP 方法
GET
所需访问权限
无
请求
参数
| 参数名称 | 类型 | 必须 | 说明 |
|---|---|---|---|
| offset | 数值或字符串 | 可省略 | 要从获取的列表中跳过的数量。 若省略，则设置为 0。 |
| limit | 数值或字符串 | 可省略 | 可获取的插件数量的上限。 可指定 1 到 100 之间的数字。 若省略，则设置为 100。 |
请求示例（当URL中包含参数时）
URL
https://(子域名).cybozu.cn/k/v1/plugins/required.json?offset=1&limit=1
头部
{
"X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}有关请求头部的更多信息，请参考共通规格。
kintone REST API 的共通规格
请求示例（当请求正文包含参数时）
URL
https://(子域名).cybozu.cn/k/v1/plugins/required.json
头部
{
"X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
"Content-Type": "application/json"
}有关请求头部的更多信息，请参考共通规格。
kintone REST API 的共通规格
正文
{
"offset": 1,
"limit": 1
}应答
属性
| 属性名称 | 类型 | 说明 |
|---|---|---|
| plugins | 数组（对象） | 需要安装的插件列表 按插件 ID 升序排列。 |
| plugins[].id | 字符串 | 插件 ID |
| plugins[].name | 字符串 | 插件名称 |
| plugins[].isMarketPlugin | 布尔值 | 是否是插件商城中的插件
|
响应范例
{
"plugins": [
{
"id": "djmhffjhfgmebgnmcggopedaofckljlj",
"name": "插件范例",
"isMarketPlugin": false
}
]
}示例代码
使用 curl 发送请求
curl -X GET 'https://(子域名).cybozu.cn/k/v1/plugins/required.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('/k/v1/plugins/required.json', true), 'GET', body);