kintone APIドキュメント

アプリにプラグインを追加する

目次

アプリにプラグインを追加する

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

アプリにプラグインを追加します。

URL

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

通常のアプリ
https://sample.cybozu.com/k/v1/preview/app/plugins.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/ゲストスペースID/v1/preview/app/plugins.json

HTTPメソッド

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

POST

必要なアクセス権

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

  • アプリ管理権限

リクエスト

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

パラメーター
パラメーター名 型 必須 説明
app 数値または文字列 必須 アプリID
ids 配列（文字列） 必須 追加するプラグインID
kintoneシステム管理で読み込んだプラグインを指定できます。
revision 数値または文字列 省略可 期待しているリビジョン番号
実際のリビジョン番号と一致しない場合はエラーとなり、設定は変更されません。
値に「-1」を指定する、または指定しなかった場合はリビジョン番号は検証されません。
リクエストの例
ヘッダー
1
2
3
4

{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

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

ボディ
1
2
3
4

{
  "app": 2,
  "ids": ["djmhffjhfgmebgnmcggopedaofckljlj"]
}

レスポンス

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

プロパティ
プロパティ名 型 説明
revision 文字列 アプリの設定を変更したあとのリビジョン番号
レスポンスの例
1
2
3

{
  "revision": "2"
}

サンプルコード

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

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

curl -X POST 'https://sample.cybozu.com/k/v1/preview/app/plugins.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": "2",
    "ids": ["djmhffjhfgmebgnmcggopedaofckljlj"]
  }'
kintone.api()を使ったリクエスト

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

1
2
3
4
5
6

const body = {
  app: kintone.app.getId(),
  ids: ['djmhffjhfgmebgnmcggopedaofckljlj']
};

await kintone.api(kintone.api.url('/k/v1/preview/app/plugins.json', true), 'POST', body);

備考

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