获取已添加插件的应用信息列表。
也可获取未反映到正式环境的添加插件的应用信息。
URL
https://(子域名).cybozu.cn/k/v1/plugin/apps.json
HTTP 方法
GET
所需访问权限
cybozu.cn共通管理员
请求
参数
| 参数名称 | 类型 | 必须 | 说明 |
|---|---|---|---|
| id | 字符串 | 必须 | 插件的id。 |
| offset | 数值或字符串 | 可省略 | 从获取到的已添加应用列表中要跳过的数量。 若省略，则设置为 0。 |
| limit | 数值或字符串 | 可省略 | 最多可获取的应用数量。 可指定 1 到 500 之间的数字。 若省略，则设置为 100。 |
请求示例（当 URL 中包含参数时）
URL
https://(子域名).cybozu.cn/k/v1/plugin/apps.json?id=piaocapmknbcjempehanpoeepiopanmm&offset=1&limit=1
头部
{
"X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}有关请求头部的更多信息，请参考共通规格。
kintone REST API 的共通规格
请求示例（当请求正文包含参数时）
URL
https://(子域名).cybozu.cn/k/v1/plugin/apps.json:
头部
{
"X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
"Content-Type": "application/json"
}有关请求头部的更多信息，请参考共通规格。
kintone REST API 的共通规格
正文
{
"id": "djmhffjhfgmebgnmcggopedaofckljlj",
"offset": 1,
"limit": 1
}应答
属性
| 属性名称 | 类型 | 说明 |
|---|---|---|
| apps | 数组（对象） | 已添加插件的应用信息的数组。 按应用 ID 升序排列。 |
| apps[].id | 字符串 | 应用ID |
| apps[].name | 字符串 | 应用名称 |
响应范例
{
"apps": [
{
"id": "1",
"name": "应用名称"
}
]
}示例代码
使用 curl 发送请求
curl -X GET 'https://(子域名).cybozu.cn/k/v1/plugin.json' \
-H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
-H 'Content-Type: application/json' \
-d '{
"id": "djmhffjhfgmebgnmcggopedaofckljlj",
"limit": 1
}'使用kintone.api()发送请求
kintone.api()的详情请参考以下文章。
发送 kintone REST API 请求
const body = {
id: 'djmhffjhfgmebgnmcggopedaofckljlj',
limit: 1,
};
await kintone.api(kintone.api.url('/k/v1/plugin/apps.json', true), 'GET', body);