kintone APIドキュメント

インストール済みのプラグインの一覧を取得する

目次

information

このページで説明しているAPIは、2024年7月版で正式リリースされます。
インストール済みのプラグインの一覧を取得する

インストール済みのプラグインの一覧を取得する

固定リンクがコピーされました

インストール済みのプラグインの一覧を取得します。

URL

固定リンクがコピーされました

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

HTTPメソッド

固定リンクがコピーされました

GET

必要なアクセス権

固定リンクがコピーされました

なし

リクエスト

固定リンクがコピーされました

パラメーター
パラメーター名 型 必須 説明
offset 数値 省略可 インストール済みのプラグイン一覧からスキップする数。
省略すると、0が設定されます。
limit 数値 省略可 取得するプラグイン数の上限。
1から100までの数値を指定できます。
省略すると、100が設定されます。
リクエストの例 （URLにパラメーターを含める場合）
URL

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

ヘッダー
1
2
3

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

リクエストヘッダーの詳細は kintone REST APIの共通仕様を参照してください。

リクエストの例 （リクエストボディにパラメーターを含める場合）
URL

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

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

レスポンス

固定リンクがコピーされました

プロパティ
プロパティ名 型 説明
plugins Array インストール済みのプラグインの一覧
インストールした日時の降順でソートされます。
plugins[].id 文字列 プラグインID
plugins[].name 文字列 プラグイン名
plugins[].isMarketPlugin 真偽値 プラグインストアのプラグインかどうか
  • true：プラグインストアのプラグインである
  • false：プラグインストアのプラグインではない
plugins[].version 文字列 プラグインバージョン
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "plugins": [
    {
      "id": "1",
      "name": "プラグイン名",
      "isMarketPlugin": false,
      "version": "1.0.0"
    }
  ]
}