kintone 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=djmhffjhfgmebgnmcggopedaofckljlj&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": "djmhffjhfgmebgnmcggopedaofckljlj",
  "offset": 1,
  "limit": 1
}

レスポンス

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

プロパティ
プロパティ名 型 説明
apps 配列（オブジェクト） プラグインが追加されているアプリ情報の配列
並び順は、アプリIDの昇順です。
追加しているアプリが存在しない場合は、空配列が返ります。
apps[].id 文字列 アプリID
apps[].name 文字列 アプリ名
レスポンスの例
1
2
3
4
5
6
7
8

{
  "apps": [
    {
      "id": "1",
      "name": "サンプルアプリ"
    }
  ]
}

サンプルコード

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

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

curl -X GET 'https://sample.cybozu.com/k/v1/plugin/apps.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "djmhffjhfgmebgnmcggopedaofckljlj",
    "limit": 1
  }'
kintone.api()を使ったリクエスト

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

1
2
3
4
5
6

const body = {
  id: 'djmhffjhfgmebgnmcggopedaofckljlj',
  limit: 1,
};

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