このページで説明しているAPIは、2024年5月版で正式リリースされました。
アプリに追加されているプラグインの一覧を取得する
アプリに追加されているプラグインの一覧を取得する
アプリに追加されているプラグインの一覧を取得します。
利用するには開発中の新機能の「アプリに追加されているプラグインを取得または追加する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 | 文字列 | 省略可 | 取得するプラグイン名の
ロケール
言語設定が「Webブラウザーの設定に従う」の場合、「Accept-Language」ヘッダーの有無によって、取得する言語が変わります。
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
plugins | 配列(オブジェクト) | アプリに追加されているプラグインの情報 |
plugins[].id | 文字列 | プラグインのID |
plugins[].name | 文字列 | プラグインの名前 |
plugins[].enabled | 真偽値 | プラグインが有効かどうか
|
revision | 文字列 | アプリの設定のリビジョン番号 |
レスポンスの例
|
|