アプリに追加されているプラグインを取得する

目次

caution
警告

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

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

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

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

アプリに追加されているプラグインを取得する

アプリに追加されているプラグインを取得します。

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

URL

URL は運用環境の設定を取得する場合と、動作テスト環境の設定を取得する場合とで異なります。

運用環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/app/plugins.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/app/plugins.json
動作テスト環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/preview/app/plugins.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/preview/app/plugins.json

HTTP メソッド

GET

必要なアクセス権

  • アプリ管理権限

リクエスト

パラメーター
パラメーター名 必須 説明
app 数値または文字列 必須 アプリ ID
lang 文字列 省略可 取得するプラグイン名の ロケール
  • ja:日本語
  • en:英語
  • zh:中国語
  • es : スペイン語
省略すると、API を実行するユーザーが表示言語に設定している言語が適用されます。
言語設定が「Webブラウザーの設定に従う」の場合、「Accept-Language」ヘッダーの有無によって、取得する言語が変わります。
  • ヘッダーあり:「Accept-Language」ヘッダーで指定した言語
  • ヘッダーなし:cybozu.com 共通管理の ロケールの設定 (External link) で設定した言語

レスポンス

プロパティ
プロパティ名 説明
plugins 配列(オブジェクト) アプリに追加されているプラグインの情報
plugins[].id 文字列 プラグインの ID
plugins[].name 文字列 プラグインの名前
plugins[].enabled 真偽値 プラグインが有効かどうか
  • true:有効
  • false:無効
revision 文字列 アプリの設定のリビジョン番号
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "plugins": [
        {
            "id": "djmhffjhfgmebgnmcggopedaofckljlj",
            "name": "プラグイン名",
            "enabled": true
        }
    ],
    "revision": "2"
}