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

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

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

HTTPメソッド	POST
URL	https://sample.cybozu.com/k/v1/preview/app/plugins.json
URL（ゲストスペース）	https://sample.cybozu.com/k/guest/`ゲストスペースID`/v1/preview/app/plugins.json
認証	パスワード認証 , APIトークン認証 , セッション認証 , OAuth認証
Content-Type	application/json

リクエストパラメーター

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

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

レスポンスプロパティ

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

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

必要なアクセス権

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

アプリ管理権限

サンプル

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

サンプルリクエスト

リクエストヘッダー

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"]
}

サンプルレスポンス

1
2
3


{
  "revision": "2"
}

サンプルコード

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);

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

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"]
  }'

補足

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

利用を許可していないプラグインも、このAPIでアプリに追加できます。
kintoneヘルプ：プラグインの利用許可を設定する

kintone API

kintone APIドキュメント

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

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

補足