kintone 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 文字列 省略可 取得するプラグイン名のロケール
kintoneプラグイン開発手順｜指定できるロケール
  • ja：日本語
  • en：英語
  • zh：中国語
  • es : スペイン語
省略すると、APIを実行するユーザーが表示言語に設定している言語が適用されます。
言語設定が「Webブラウザーの設定に従う」の場合、「Accept-Language」ヘッダーの有無によって、取得する言語が変わります。
  • ヘッダーあり：「Accept-Language」ヘッダーで指定した言語
  • ヘッダーなし：cybozu.com共通管理のロケールの設定で設定した言語
    ロケールの設定 (External link)
リクエストの例
ヘッダー
1
2
3
4

{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

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

ボディ
1
2
3
4

{
  "app": 1,
  "lang": "ja"
}

レスポンス

固定リンクがコピーされました

プロパティ
プロパティ名 型 説明
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"
}

サンプルコード

固定リンクがコピーされました

curlを使ったリクエスト
1
2
3
4
5
6
7

curl -X GET 'https://sample.cybozu.com/k/v1/app/plugins.json' \
  -H 'X-Cybozu-API-Token: "API_TOKEN"' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "lang": "ja"
  }'
kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信するAPI

1
2
3
4
5

const body = {
  app: 1,
  lang: 'ja'
};
await kintone.api(kintone.api.url('/k/v1/app/plugins.json', true), 'GET', body);