インストールが必要なプラグインの一覧を取得する

kintoneにインストールが必要なプラグインの一覧を取得します。

HTTPメソッド	GET
URL	https://sample.cybozu.com/k/v1/plugins/required.json
認証	パスワード認証 , セッション認証 , OAuth認証
Content-Type	application/json（クエリ文字列でクエリを指定する場合は不要）

リクエストパラメーター

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

パラメーター名	型	必須	説明
offset	数値または文字列	省略可	取得する一覧からスキップする数。省略すると、0が設定されます。
limit	数値または文字列	省略可	取得するプラグイン数の上限。 1から100までの数値を指定できます。省略すると、100が設定されます。

レスポンスプロパティ

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

プロパティ名	型	説明
plugins	配列（オブジェクト）	インストールが必要なプラグインの一覧並び順は、プラグインIDの昇順です。プラグインが存在しない場合は、空配列が返ります。
plugins[].id	文字列	プラグインID
plugins[].name	文字列	プラグインの名前取得できない場合は`null`が返ります。
plugins[].isMarketPlugin	真偽値	プラグインストアのプラグインかどうか `true`：プラグインストアのプラグインである `false`：プラグインストアのプラグインではない

必要なアクセス権

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

なし

サンプル

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

サンプルリクエスト

リクエストURL（URLにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/plugins/required.json?offset=1&limit=1

リクエストヘッダー（URLにパラメーターを含める場合）

1
2
3


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

リクエストURL（リクエストボディにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/plugins/required.json

リクエストヘッダー（リクエストボディにパラメーターを含める場合）

1
2
3
4


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

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

リクエストボディ（リクエストボディにパラメーターを含める場合）

1
2
3
4


{
  "offset": 1,
  "limit": 1
}

サンプルレスポンス

1
2
3
4
5
6
7
8
9


{
  "plugins": [
    {
      "id": "djmhffjhfgmebgnmcggopedaofckljlj",
      "name": "サンプルプラグイン",
      "isMarketPlugin": false
    }
  ]
}

サンプルコード

kintone.api()を使ったリクエスト

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

1
2
3
4
5


const body = {
  limit: 1,
};

await kintone.api(kintone.api.url('/k/v1/plugins/required.json', true), 'GET', body);

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

1
2
3
4
5
6


curl -X GET 'https://sample.cybozu.com/k/v1/plugins/required.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "limit": 1
  }'

kintone API

kintone APIドキュメント

インストールが必要なプラグインの一覧を取得する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル