アプリに追加されているプラグインの設定情報を取得する

目次

caution
警告

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

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

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

フィードバックの例
  • 「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 オブジェクト プラグインの設定情報
キーと値を対にしたオブジェクトの形式で、設定情報が返ります。
例:
{
"key1": "value1",
"key2": "value2"
}
revision 文字列 アプリの設定のリビジョン番号
レスポンスの例
1
2
3
4
5
6
7
{
   "config": {
      "key1": "value1",
      "key2": "value2"
   },
   "revision": 2
}