kintone APIドキュメント

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

目次

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

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

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

URL

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

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

HTTPメソッド

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

GET

必要なアクセス権

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

なし

リクエスト

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

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

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

ヘッダー
1
2
3

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

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

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

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
}

レスポンス

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

プロパティ
プロパティ名 型 説明
plugins 配列（オブジェクト） インストールが必要なプラグインの一覧

並び順は、プラグインIDの昇順です。
プラグインが存在しない場合は、空配列が返ります。
plugins[].id 文字列 プラグインID
plugins[].name 文字列 プラグインの名前
取得できない場合はnullが返ります。
plugins[].isMarketPlugin 真偽値 プラグインストアのプラグインかどうか
  • true：プラグインストアのプラグインである
  • false：プラグインストアのプラグインではない
レスポンスの例
1
2
3
4
5
6
7
8
9

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

サンプルコード

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

curlを使ったリクエスト
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()の詳細は、次のページを参照してください。
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);