kintone API

獲取已安裝外掛程式的清單

獲取已導入kintone的外掛程式清單。

目錄

HTTP 方法GET
URLhttps://sample.cybozu.com/k/v1/plugins.json
認證 密碼驗證 , 會話認證
Content-Typeapplication/json(透過查詢字串指定查詢時不需指定此項)

請求參數

參數名稱 類型 必須 說明
offset 數值或字串 可省略 要從要獲取的組織開頭跳過的數位
如果省略,則設置為0。
limit 數值或字串 可省略 要獲取的外掛程式的最大數量。
您可以指定一個介於 1 和 100 之間的數值。
如果省略,則設置為100。
ids 陣列 可省略 要獲取的外掛程式ID。
您最多可以指定 100 個。

應答屬性

屬性名稱 類型 說明
plugins 陣列(物件) 匯入的外掛程式清單
排序順序按安裝日期和時間降序排列。
如果外掛程式不存在,則返回一個空數組。
plugins[].id 字串 外掛程式ID
plugins[].name 字串 外掛程式的名稱
plugins[].description 字串 外掛程式的說明
plugins[].isMarketPlugin 布爾值 是否外掛程式商城中的外掛程式
  • true:它是外掛程式商城中的外掛程式
  • false:不是外掛程式商城中的外掛程式
plugins[].version 字串 外掛程式版本

所需存取權限

範例

1
https\://sample.cybozu.com/k/v1/plugins.json?offset=1&limit=1
1
2
3
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

1
https\://sample.cybozu.com/k/v1/plugins.json
1
2
3
4
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

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

1
2
3
4
5
{
  "offset": 0,
  "limit": 1,
  "ids": ["piaocapmknbcjempehanpoeepiopanmm"]
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "plugins": [
    {
      "id": "djmhffjhfgmebgnmcggopedaofckljlj",
      "name": "範例外掛程式",
      "description": "外掛程式的說明",
      "isMarketPlugin": false,
      "version": "1.0.0"
    }
  ]
}

有關kintone.api()的說明,請參閱以下頁面。
傳送kintone REST API請求

1
2
3
4
5
const body = {
  limit: 1,
};

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

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

1
2
3
4
5
6
curl -X GET 'https://sample.cybozu.com/k/v1/plugins.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "limit": 1
  }'