kintone API文件

獲取需要安裝的外掛程式清單

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

獲取需要安裝的外掛程式清單

連結已複製

獲取kintone中需要安裝的外掛程式清單。

URL

連結已複製

https://sample.cybozu.com/k/v1/plugins/required.json

HTTP 方法

連結已複製

GET

所需存取權限

連結已複製

無

請求

連結已複製

參數
參數名稱 類型 必須 說明
offset 數值或字串 可省略 要從清單中跳過以獲取的號碼。
如果省略，則設置為0。
limit 數值或字串 可省略 要獲取的外掛程式的最大數量。
您可以指定一個介於 1 和 100 之間的數值。
如果省略，則設置為100。
範例請求（如果要在網址中包含參數 ）
URL

https://sample.cybozu.com/k/v1/plugins/required.json?offset=1&limit=1

標頭
1
2
3

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

有關請求頭的詳細資訊，請參閱通用規格。
kintone REST API通用規範

範例請求（如果要在請求內文中包含參數）
URL

https://sample.cybozu.com/k/v1/plugins/required.json

標頭
1
2
3
4

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

有關請求頭的詳細資訊，請參閱通用規格。
kintone REST API通用規範

內文
1
2
3
4

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

回應

連結已複製

屬性
屬性名稱 類型 說明
plugins 陣列（物件） 需要安裝的外掛程式

排序順序按外掛程式ID升序。
如果外掛程式不存在，則返回一個空數組。
plugins[].id 字串 外掛程式ID
plugins[].name 字串 外掛程式的名稱
如果選取不到，返回null。
plugins[].isMarketPlugin 布爾值 是否外掛程式商城中的外掛程式
  • true：它是外掛程式商城中的外掛程式
  • false：不是外掛程式商城中的外掛程式
示例回應
1
2
3
4
5
6
7
8
9

{
  "plugins": [
    {
      "id": "djmhffjhfgmebgnmcggopedaofckljlj",
      "name": "樣本外掛程式",
      "isMarketPlugin": false
    }
  ]
}

示例代碼

連結已複製

使用 curl 的請求
1
2
3
4
5
6

curl -X GET 'https://sample.cybozu.com/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請求

1
2
3
4
5

const body = {
  limit: 1,
};

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