このページで説明しているAPIは、2024年7月版で正式リリースされます。
プラグインを追加しているアプリの一覧を取得する
対象のプラグインを追加しているアプリの一覧を取得する
対象のプラグインを追加しているアプリの一覧を取得します。
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
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST APIの共通仕様を参照してください。
リクエストの例 (リクエストボディにパラメーターを含める場合)
URL
https://sample.cybozu.com/k/v1/plugin/apps.json:
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST APIの共通仕様を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
apps | Array | デプロイ前・デプロイ済みのプラグインが追加されているアプリ情報の配列。 アプリIDの昇順でソートされます。 |
apps[].id | 文字列 | アプリID |
apps[].name | 文字列 | アプリ名 |
レスポンスの例
|
|