対象のプラグインを追加しているアプリの一覧を取得する

目次

caution
警告

このページで説明しているAPIは、開発を検討中のAPIです。

アップデートオプション内の「開発中の新機能」から動作をお試しいただけます。 設定方法は、 新機能の有効/無効の切り替え手順 (External link) を参照してください。

APIに関するフィードバックを、ユースケースとともに、 kintoneの改善に協力する (External link) フォームへぜひご登録ください。

フィードバックの例
  • APIラボで提供されているAPIを早く本番環境で利用したい
  • こういう用途で使うために、このようなAPIを提供してほしい

対象のプラグインを追加しているアプリの一覧を取得する

対象のプラグインを追加しているアプリの一覧を取得します。

利用するには開発中の新機能の「対象のプラグインを追加しているアプリの一覧を取得できるREST API」を有効にしてください。

URL

https://sample.cybozu.com/k/v1/plugin/apps.json

HTTPメソッド

GET

必要なアクセス権

  • cybozu.com共通管理者

リクエスト

パラメーター
パラメーター名 必須 説明
id 文字列 必須 追加したアプリの一覧を取得したいプラグインのid。
インストール有無にかかわらず指定可能。
offset 数値 省略可 取得した追加したアプリの一覧からスキップする数。
省略すると、0が設定されます。
limit 数値 省略可 取得するアプリ数の上限。
1から500までの数値を指定できます。
省略すると、100が設定されます。
リクエストの例 (URLにパラメーターを含める場合)
URL

https://sample.cybozu.com/k/v1/plugin/apps.json?id=piaocapmknbcjempehanpoeepiopanmm&offset=1&limit=1

ヘッダー
1
2
3
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

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

https://sample.cybozu.com/k/v1/plugin/apps.json:

ヘッダー
1
2
3
4
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

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

ボディ
1
2
3
4
5
{
  "id": "piaocapmknbcjempehanpoeepiopanmm",
  "offset": 1,
  "limit": 1
}

レスポンス

プロパティ
プロパティ名 説明
apps Array デプロイ前・デプロイ済みのプラグインが追加されているアプリ情報の配列。
アプリIDの昇順でソートされます。
apps[].id 文字列 アプリID
apps[].name 文字列 アプリ名
レスポンスの例
1
2
3
4
5
6
7
8
{
  "apps": [
    {
      "id": "1",
      "name": "アプリ名"
    }
  ]
}