kintone JavaScript API一覧

イベントの利用方法については、イベント処理の記述方法 を参照してください。

イベント

イベントが発生するタイミング		イベントタイプ	PC	Mobile
レコード一覧画面	表示後	app.record.index.show
	インライン編集開始	app.record.index.edit.show
	インライン編集のフィールド値変更	app.record.index.edit.change.<フィールドコード>
	インライン編集の保存実行前	app.record.index.edit.submit
	インライン編集の保存成功後	app.record.index.edit.submit.success
	レコード削除前	app.record.index.delete.submit
レコード詳細画面	表示後	app.record.detail.show
	削除前	app.record.detail.delete.submit
	プロセス管理のアクション実行	app.record.detail.process.proceed
レコード追加画面	表示後	app.record.create.show
	フィールド値変更	app.record.create.change.<フィールドコード>
	保存実行前	app.record.create.submit
	保存成功後	app.record.create.submit.success
レコード編集画面	表示後	app.record.edit.show
	フィールド値変更	app.record.edit.change.<フィールドコード>
	保存実行前	app.record.edit.submit
	保存成功後	app.record.edit.submit.success
レコード印刷画面	表示後	app.record.print.show
グラフ画面	表示後	app.report.show
ポータル画面	表示後	portal.show

イベントハンドラーの登録・削除

API	関数名	PC	Mobile
イベントハンドラーの登録	kintone.events.on
イベントハンドラーの削除	kintone.events.off

API実行

API		関数名	PC	Mobile
REST API	実行	kintone.api
	URLを取得	kintone.api.url
	URLを取得（クエリ文字列付き）	kintone.api.urlForGet
	CSRFトークンの取得	kintone.getRequestToken
	同時接続数の取得	kintone.api.getConcurrencyLimit
プロキシ	外部APIの実行	kintone.proxy
	外部にファイルをアップロード	kintone.proxy.upload

情報の取得・設定

API		関数名	PC	Mobile
レコード	レコードID取得	kintone.app.record.getId
	値を取得	kintone.app.record.get
	値をセット	kintone.app.record.set
	レコード一覧	クエリ文字列取得	kintone.app.getQueryCondition
		クエリ文字列取得（オプション付き）	kintone.app.getQuery
アプリ	アプリID取得	kintone.app.getId
	ルックアップフィールドの対象アプリIDを取得	kintone.app.getLookupTargetAppId
	関連レコード一覧の対象アプリIDを取得	kintone.app.getRelatedRecordsTargetAppId
ユーザー	ログインユーザー情報の取得	kintone.getLoginUser
UI	kintoneのUIバージョンを取得	kintone.getUiVersion

フィールド表示・非表示

API	関数名	PC	Mobile
フィールドの表示・非表示	kintone.app.record.setFieldShown
グループフィールドの開閉	kintone.app.record.setGroupFieldOpen

要素の取得

API		関数名	PC	Mobile
レコード	フィールド要素取得	kintone.app.record.getFieldElement
	メニューの上側の空白部分の要素を取得	kintone.app.record.getHeaderMenuSpaceElement
	スペースフィールドの要素を取得	kintone.app.record.getSpaceElement
レコード一覧	フィールド要素取得	kintone.app.getFieldElements
	メニューの右側の空白部分の要素を取得	kintone.app.getHeaderMenuSpaceElement
	メニューの下側の空白部分の要素を取得	kintone.app.getHeaderSpaceElement
レコード、レコード一覧	ヘッダー直下の空白部分の要素を取得（モバイル）	kintone.mobile.app.getHeaderSpaceElement
ポータル	ポータルの上側の空白部分の要素を取得する	kintone.portal.getContentSpaceElement

プラグイン

API		関数名	PC	Mobile
プラグイン	設定情報の取得	kintone.plugin.app.getConfig
	設定情報の保存	kintone.plugin.app.setConfig
	外部APIの実行	kintone.plugin.app.proxy
	外部APIのリクエスト情報の取得	kintone.plugin.app.getProxyConfig
	外部APIのリクエスト情報の保存	kintone.plugin.app.setProxyConfig
	外部にファイルをアップロード	kintone.plugin.app.proxy.upload