インストールが必要なプラグインの一覧を取得する

目次

information

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

インストールが必要なプラグインの一覧を取得する

インストールが必要なプラグインの一覧を取得します。

URL

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

HTTPメソッド

GET

必要なアクセス権

なし

リクエスト

パラメーター
パラメーター名 必須 説明
offset 数値 省略可 インストールが必要なプラグイン一覧からスキップする数。
省略すると、0が設定されます。
limit 数値 省略可 取得するプラグイン数の上限。
1から100までの数値を指定できます。
省略すると、100が設定されます。
リクエストの例 (URLにパラメーターを含める場合)
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 Array インストールが必要なプラグインの一覧
プラグインIDの昇順でソートされます。
plugins[].id 文字列 プラグインID
plugins[].name 文字列 プラグイン名
plugins[].isMarketPlugin 真偽値 プラグインストアのプラグインかどうか
  • true:プラグインストアのプラグインである
  • false:プラグインストアのプラグインではない
レスポンスの例
1
2
3
4
5
6
7
8
9
{
  "plugins": [
    {
      "id": "1",
      "name": "プラグイン名",
      "isMarketPlugin": false
    }
  ]
}