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

目次

caution
警告

このページで説明している API は、開発を検討中の API です。

アップデートオプション内の「開発中の新機能」から動作をお試しいただけます。
設定方法は、 新機能の有効/無効の切り替え手順 (External link) を参照してください。

API に関するフィードバックを、ユースケースとともに、 kintone の改善に協力する (External link) フォームへぜひご登録ください。

フィードバックの例
  • API ラボで提供されている API を早く本番環境で利用したい
  • こういう用途で使うために、このような API を提供してほしい

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

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

利用するには開発中の新機能の「kintone にインストールが必要なプラグインの一覧を取得できる REST API」を有効にしてください。

URL

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

HTTP メソッド

GET

必要なアクセス権

  • cybozu.com 共通管理者

リクエスト

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

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

ヘッダー
1
2
3
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

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

https://sample.cybozu.com/k/v1/admin/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
    }
  ]
}