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

目次

caution
警告

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

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

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

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

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

アプリに追加されているプラグインの設定情報を変更します。

利用するには開発中の新機能の「アプリに追加されているプラグインの設定情報を取得または更新する REST API」を有効にしてください。

URL

通常のアプリ
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 メソッド

PUT

必要なアクセス権

  • アプリ管理権限

リクエスト

パラメーター
パラメーター名 必須 説明
app 数値または文字列 必須 アプリ ID
id 文字列 必須 プラグイン ID
config オブジェクト 必須 プラグイン の設定情報
キーと値の文字列を対にしたオブジェクトの形式で指定してください。
例:
{
"key1": "value1",
"key2": "value2"
}
リクエストの例
ヘッダー
1
2
3
4
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

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

ボディ
1
2
3
4
5
6
7
8
{
   "app": 1,
   "id": "djmhffjhfgmebgnmcggopedaofckljlj",
   "config": {
      "key1": "value1",
      "key2": "value2"
   }
}

レスポンス

プロパティ
プロパティ名 説明
revision 文字列 アプリの設定を変更したあとのリビジョン番号