プラグインの基本設定を取得する
プラグインの基本設定を取得する
プラグインが有効かどうかや、プラグインの適用対象を取得します。
URL
https://sample.cybozu.com/g/api/v1/system/plugin/admin/settings/PLUGIN_ID
パスパラメーター
パラメーター名 | 説明 |
---|---|
PLUGIN_ID | 基本設定を取得するプラグインのプラグインID |
HTTPメソッド
GET
利用できるバージョン
- クラウド版Garoon
必要なアクセス権
次のいずれかの権限が必要です。
- Garoonのシステム管理者権限
- 予定のアプリケーション管理者権限
リクエスト
パラメーター
なし
リクエストの例
URL
https://sample.cybozu.com/g/api/v1/system/plugin/admin/settings/1
ヘッダー
|
|
リクエストヘッダーの詳細は Garoon REST APIの共通仕様を参照してください。
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
isActive | 真偽値 | プラグインの利用が有効かどうか
|
appliedTo[].id | 文字列 | 適用対象のIDappliedTo[].type ごとに内容が異なります。
|
appliedTo[].code | オブジェクト | 適用対象のコードappliedTo[].type ごとに内容が異なります。
|
appliedTo[].name | 文字列 | 適用対象の名前appliedTo[].type ごとに内容が異なります。
|
appliedTo[].type | 文字列 | 適用対象のタイプ
|
サンプルコード
curlを使ったリクエスト
|
|
Garoon REST APIリクエストを送信するAPIを使ったリクエスト
|
|