警告
このページで説明しているAPIは、開発を検討中のAPIです。
アップデートオプション内の「開発中の新機能」から動作をお試しいただけます。
設定方法は、
新機能の有効/無効の切り替え手順
を参照してください。
APIに関するフィードバックを、ユースケースとともに、 kintoneの改善に協力する フォームへぜひご登録ください。
フィードバックの例
- 「APIラボで提供されているAPIを早く本番環境で利用したい」
- 「こういう用途で使うために、このようなAPIを提供してほしい」
アプリに追加されているプラグインの設定情報を取得する
アプリに追加されているプラグインの設定情報を取得します。
利用するには開発中の新機能の「アプリに追加されているプラグインの設定情報を取得または更新するREST API」を有効にしてください。
URL
URLは運用環境の設定を取得する場合と、動作テスト環境の設定を取得する場合とで異なります。
運用環境の設定を取得する場合
- 通常のアプリ
- https://sample.cybozu.com/k/v1/app/plugin/config.json
- ゲストスペースのアプリ
- https://sample.cybozu.com/k/guest/
ゲストスペースID
/v1/app/plugin/config.json
動作テスト環境の設定を取得する場合
- 通常のアプリ
- https://sample.cybozu.com/k/v1/preview/app/plugin/config.json
- ゲストスペースのアプリ
- https://sample.cybozu.com/k/guest/
ゲストスペースID
/v1/preview/app/plugin/config.json
HTTPメソッド
GET
必要なアクセス権
運用環境の設定を取得する場合
- アプリのレコード閲覧権限
- アプリのレコード追加権限
動作テスト環境の設定を取得する場合
- アプリ管理権限
リクエスト
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
app | 数値または文字列 | 必須 | アプリID |
id | 文字列 | 必須 | プラグインID |
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
config | オブジェクト | プラグインの設定情報 キーと値を対にしたオブジェクトの形式で、設定情報が返ります。 例: { |
revision | 文字列 | アプリの設定のリビジョン番号 |
レスポンスの例
|
|