警告
このページで説明しているAPIは、開発を検討中のAPIです。
アップデートオプション内の「開発中の新機能」から動作をお試しいただけます。
設定方法は、
新機能の有効/無効の切り替え手順
を参照してください。
APIに関するフィードバックを、ユースケースとともに、 kintone の改善に協力する フォームへぜひご登録ください。
- フィードバックの例
- 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
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様を参照してください。
リクエストの例 (リクエストボディにパラメーターを含める場合)
URL
https://sample.cybozu.com/k/v1/admin/plugins/required.json
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
plugins | Array | インストールが必要なプラグインの一覧 プラグインIDの昇順でソートされます。 |
plugins[].id | 文字列 | プラグインID |
plugins[].name | 文字列 | プラグイン名 |
plugins[].isMarketPlugin | 真偽値 | プラグインストアのプラグインかどうか
|
レスポンスの例
|
|