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

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

HTTP 方法	取得
URL	https://sample.cybozu.com/k/v1/plugins/required.json
認證	密碼驗證 , 會話認證
Content-Type	application/json（透過查詢字串指定查詢時不需指定此項）

請求參數

連結已複製

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

回應屬性

連結已複製

屬性名稱	類型	說明
plugins	陣列（物件）	需要安裝的外掛程式排序順序按外掛程式ID升序。如果外掛程式不存在，則返回一個空數組。
plugins[].id	字串	外掛程式ID
plugins[].name	字串	外掛程式的名稱如果選取不到，返回`null`。
plugins[].isMarketPlugin	布爾值	是否外掛程式商城中的外掛程式 `true`：它是外掛程式商城中的外掛程式 `false`：不是外掛程式商城中的外掛程式

所需存取權限

連結已複製

無

範例

連結已複製

請求範例

請求URL（在URL中包含參數的情況）

1

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

請求標頭（在URL中包含參數的情況）

1
2
3


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

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

請求URL（在請求主體中包含參數的情況）

1

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
}

範例回應

1
2
3
4
5
6
7
8
9


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

範例程式碼

使用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);

使用curl傳送請求

根據您的環境，curl的格式可能會有所不同。
有關說明，請參閱以下頁面。
使用curl命令執行kintone REST API/3.執行API

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文件

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

目錄

請求參數

回應屬性

所需存取權限

範例