API ラボ(開発中の新機能)

目次

API ラボページで説明している API は、開発を検討中の API です。
API ラボの概要は、 「API ラボ」とは を参照してください。

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

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

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

API 以外の開発中の新機能については、 「開発中の新機能」の対象機能 (External link) を参照してください。

REST API

アプリ

API HTTPメソッド URL
アプリの一般設定を取得する
(取得できる項目が増える)
GET /k/v1/app/settings.json
/k/v1/preview/app/settings.json
アプリの一般設定を変更する
(変更できる項目が増える)
PUT /k/v1/preview/app/settings.json
アプリ管理者用メモを取得する GET /k/v1/app/adminNotes.json
/k/v1/preview/app/adminNotes.json
アプリ管理者用メモを変更する PUT /k/v1/preview/app/adminNotes.json
カテゴリの設定情報を取得する GET /k/v1/app/categories.json
/k/v1/preview/app/categories.json
カテゴリの設定情報を変更する PUT /k/v1/preview/app/categories.json
アプリに追加されているプラグインを取得する GET /k/v1/app/plugins.json
/k/v1/preview/app/plugins.json
アプリにプラグインを追加する POST /k/v1/preview/app/plugins.json
プラグインの設定情報を取得する GET /k/v1/app/plugin/config.json
/k/v1/preview/app/plugin/config.json
プラグインの設定情報を変更する PUT /k/v1/preview/app/plugin/config.json
アプリの所属するスペースを変更する POST /k/v1/app/move.json

スペース

API HTTPメソッド URL
スペースの情報を取得する
(取得できる項目が増える)
GET /k/v1/space.json
スペースを作成する POST /k/v1/space.json
スペースの設定を変更する PUT /k/v1/space.json
スペースのスレッドを作成する POST /k/v1/space/thread.json

プラグイン

API HTTPメソッド URL
インストール済みのプラグインの一覧を取得する GET /k/v1/admin/plugins.json
インストールが必要なプラグインの一覧を取得する GET /k/v1/admin/plugins/required.json
プラグインを追加する POST /k/v1/plugin.json
プラグインを更新する PUT /k/v1/plugin.json
プラグインを削除する DELETE /k/v1/plugin.json
対象のプラグインを追加しているアプリの一覧を取得する GET /k/v1/admin/plugin/apps.json

JavaScript API

メソッド

API 関数
ログインユーザーのアプリに対するアクセス権を取得する kintone.app.getPermissions()
kintone.mobile.app.getPermissions()
ログインユーザーのレコードに対するアクセス権を取得する kintone.app.record.getPermissions()
kintone.mobile.app.record.getPermissions()
サイドバーを表示する kintone.app.record.showSideBar(mode)
サイドバーを非表示にする kintone.app.record.hideSideBar()
レコード追加ボタンの表示/非表示を変更する kintone.app.setRecordAddButtonShown(isShown)
レコード編集ボタンの表示/非表示を変更する kintone.app.record.setRecordEditButtonShown(isShown)
アプリ情報を取得する kintone.app.get()
スペース情報を取得する kintone.space.get()