Index
レコードIDを取得する
現在開いてるレコードIDを取得します。
- PC用とスマートフォン用で利用できます。
- スペースに貼りつけたアプリには利用できません。
関数
環境 | 関数 |
---|---|
PC用 | kintone.app.record.getId() |
スマートフォン用 | kintone.mobile.app.record.getId() |
引数
なし
返り値
- 数値 または null が返ります。 利用できない画面では null が返ります。
サンプル
利用できる画面(PC用)
- レコード詳細
- レコード編集
- レコード印刷
利用できる画面(スマートフォン用)
- レコード詳細
- レコード編集
レコードの値を取得する
現在開いてるレコードデータをJSON形式で取得します。
- PC用とスマートフォン用で利用できます。 利用できる関数が異なりますので、ご注意ください。
- スペースに貼りつけたアプリには利用できません。
関数
環境 | 関数 |
---|---|
PC用 | kintone.app.record.get() |
スマートフォン用 | kintone.mobile.app.record.get() |
引数
なし
返り値
- レコードデータを表すオブジェクトまたは null が返ります。 利用できない画面では null が返ります。
- レコード追加・編集画面では、編集中のレコードデータが返ります。
- レコード追加・編集画面では、添付ファイル情報は常に空配列となります。
サンプル
利用できる画面(PC用)
- レコード詳細
- レコード追加
- レコード編集
- レコード印刷
利用できる画面(スマートフォン用)
- レコード詳細
- レコード追加
- レコード編集
注意事項
- kintone.events.on のイベントハンドラ内で kintone.app.record.get および kintone.mobile.app.record.get を実行することはできません。 上記のイベントハンドラ内ではレコードデータの取得は引数のeventオブジェクトを、レコードデータの更新はeventオブジェクトのreturnを使用してください。
フィールド要素を取得する
フィールドコードを指定して、レコードに対応するフィールド要素を取得します。
- PC用のみで利用できます。
- スペースに貼りつけたアプリには利用できません。
- フィールド要素の取得 および 取得したDOMの style(装飾するためのDOM)をサポートしています。
- 取得したDOMの内部構造を変更するような処理を行うと、kintoneのバージョンアップ後に動作しなくなる可能性があります。
関数
kintone.app.record.getFieldElement(fieldCode)
引数
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
fieldCode | 文字列 | 必須 | 取得するフィールドのフィールドコードを指定します。 |
返り値
- フィールド要素または null
- 利用できない画面では null が返ります。
サンプル
取得できないフィールド
- 以下のフィールドを指定した場合 または 閲覧権限のないフィールドを指定した場合には null が返ります。
- ステータス
- 作業者
- テーブルに含まれるフィールド
- 関連レコード一覧に含まれるフィールド
利用できる画面
- レコード詳細
※アプリの動作テスト環境の画面、およびスペース内アプリの画面も含まれます。
※レコードの編集画面、および通知の詳細画面は含まれません。 - レコード印刷
レコードに値をセットする
現在開いてるレコードに値をセットします。
- 以下の処理を行うことができます。
- フィールドの値の書き換え
- フィールドの編集可/不可の設定
- フィールドのエラーの指定
- ルックアップの自動取得
- ルックアップのコピー先のフィールドの値を空にする
- PC用とスマートフォン用で利用できます。 利用できる関数が異なりますので、ご注意ください。
- スペースに貼りつけたアプリには利用できません。
関数
環境 | 関数 |
---|---|
PC用 | kintone.app.record.set(record) |
スマートフォン用 | kintone.mobile.app.record.set(record) |
引数
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
record | JSON | 必須 | セットするレコードデータを JSON で指定します。 ※形式はkintone.app.record.getの戻り値と同様です。 |
返り値
なし。
サンプル
値を設定できないフィールド
以下のフィールドは、変更が反映されません。
- 添付ファイル
利用できる画面(PC用)
- レコード追加
- レコード編集
利用できる画面(スマートフォン用)
- レコード追加
- レコード編集
注意事項
- kintone.events.on のインベントハンドラ内で kintone.app.record.set および kintone.mobile.app.record.set を実行することはできません。 上記のイベントハンドラ内ではレコードデータの取得は引数のeventオブジェクトを、レコードデータの更新はeventオブジェクトのreturnを使用してください。
メニューの上側の空白部分の要素を取得する
- PC用のみで利用できます。
- スペースに貼りつけたアプリには利用できません。
- 要素内の見た目がkintoneのCSSの影響を受ける場合があるため、その見た目が変わらないことは保証できません。
- レコード追加・編集画面などで、TYPE属性が"submit"のINPUT要素、BUTTON要素を空の要素に追加した場合、クリック時にkintone本体が予期せぬ動作をするため、これらの要素の利用は推奨いたしません。
関数
kintone.app.record.getHeaderMenuSpaceElement()
引数
なし
返り値
- メニュー(詳細画面では編集・再利用・削除など、追加・編集画面では保存・キャンセルなど)の上側の空白部分の要素を返します。
- 利用できない画面では null を返します。
サンプル
利用できる画面
- レコード詳細
- レコード追加
- レコード編集
※レコード印刷画面では利用できません。
スペースフィールドの要素を取得する
- PC用とスマートフォン用で利用できます。
関数
環境 | 関数 |
---|---|
PC用 | kintone.app.record.getSpaceElement(id) |
スマートフォン用 | kintone.mobile.app.record.getSpaceElement(id) |
引数
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
id | 文字列 | 必須 | スペースフィールドの要素ID |
返り値
- 指定された要素IDのスペースフィールドの要素を返します。
- 指定された要素IDのスペースフィールドが存在しない場合は null を返します。
- 利用できない画面では null を返します。
サンプル
利用できる画面(PC用)
- レコード詳細
- レコード追加
- レコード編集
- レコード印刷
利用できる画面(スマートフォン用)
- レコード詳細
- レコード追加
- レコード編集
関連レコード一覧の参照先のアプリIDを取得する
関連レコード一覧のフィールドコードを指定して、参照先のアプリIDを取得します。
- PC用とスマートフォン用で利用できます。
- スペースに貼りつけたアプリには利用できません。
- 指定したフィールドに対するアクセス権があれば、対象アプリの閲覧権限等がなくてもアプリIDを取得可能です。
関数
環境 | 関数 |
---|---|
PC用 | kintone.app.getRelatedRecordsTargetAppId(fieldCode) |
スマートフォン用 | kintone.mobile.app.getRelatedRecordsTargetAppId(fieldCode) |
引数
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
fieldCode | 文字列 | 必須 | 関連レコード一覧フィールドのフィールドコードを指定します。 |
返り値
- アプリの ID または null が返ります。
- 以下の場合は null が返ります。
- 指定したフィールドが存在しない
- 指定したフィールドが閲覧できない
- 指定したフィールドが関連レコード一覧フィールドではない
サンプル
利用できる画面(PC用)
- レコード一覧
- レコード追加
- レコード編集
- レコード詳細
- レコード印刷
- グラフ
- ファイル読み込み
- ファイル書き出し
- プラグインごとの設定画面
利用できる画面(スマートフォン用)
- レコード一覧
- レコード追加
- レコード編集
- レコード詳細
- グラフ
ルックアップフィールドの参照先のアプリIDを取得する
ルックアップフィールドのフィールドコードを指定して、参照先のアプリIDを取得します。
- PC用とスマートフォン用で利用できます。
- スペースに貼りつけたアプリには利用できません。
- 指定したフィールドに対するアクセス権があれば、対象アプリの閲覧権限等がなくてもアプリIDを取得可能です。
関数
環境 | 関数 |
---|---|
PC用 | kintone.app.getLookupTargetAppId(fieldCode) |
スマートフォン用 | kintone.mobile.app.getLookupTargetAppId(fieldCode) |
引数
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
fieldCode | 文字列 | 必須 | ルックアップフィールドのフィールドコードを指定します。 |
返り値
- アプリの ID または null が返ります。
- 以下の場合は null が返ります。
- 指定したフィールドが存在しない
- 指定したフィールドが閲覧できない
- 指定したフィールドがルックアップフィールドではない
サンプル
利用できる画面(PC用)
- レコード一覧
- レコード追加
- レコード編集
- レコード詳細
- レコード印刷
- グラフ
- ファイル読み込み
- ファイル書き出し
- プラグインごとの設定画面
利用できる画面(スマートフォン用)
- レコード一覧
- レコード追加
- レコード編集
- レコード詳細
- グラフ
ヘッダーの下側の空白部分の要素を取得する
- スマートフォン用のみで利用できます。
- スペースに貼りつけたアプリには利用できません。
レコード詳細画面・レコード編集画面 | レコード追加画面 |
---|---|
![]() |
![]() |
関数
kintone.mobile.app.getHeaderSpaceElement()
引数
なし
返り値
- ヘッダーとコンテンツの間の空白部分の要素を返します。
- 利用できない画面では null を返します。
サンプル
利用できる画面
- レコード一覧
- レコード詳細
- レコード追加
- レコード編集
ご担当者様
いつもお世話になっております、上澤と申します。
kintoneレコード詳細画面で、登録ボタンを押したタイミングで、userAPIのエクスポートとファイルアップロードを
順に呼び出してユーザー情報を更新しに行く処理を作成しております。
ところが、ファイルアップロード時に520エラー(CB_CS01)となります。
過去の情報を参照しましたが、解決しないため、知恵をお借りしたいです。
アップロードする","区切りのデータは、共通管理から読み込ませて問題ないため、
入力チェックに引っかかっていることはないと考えております。
以下にソースと、リクエストボディとエラー内容を記載いたします。
大変お手数ですが、どうぞよろしくお願い致します。
<使用ブラウザ>
IE11
<ソース抜粋>
====================
kintone.events.on('app.record.edit.submit', function(event) {
:(エクスポート部は省略)
// URL作成
appUrl = "https://" + subDomain + "/v1/file.json";
// boundary生成
var strBoundary = createBoundary();
// リクエスト生成
xmlHttp = new XMLHttpRequest();
xmlHttp.open("POST", appUrl, false);
xmlHttp.setRequestHeader('X-Requested-With','XMLHttpRequest');
xmlHttp.setRequestHeader('X-Cybozu-Authorization','*****'); // システム権限有
xmlHttp.setRequestHeader('Content-Type','multipart/form-data; boundary=' + strBoundary);
// リクエストボディー部を作成
var str = ""
str = str + '--' + strBoundary + '\r\n'
str = str + 'Content-Disposition: form-data; name="file"; filename="user.csv"\r\n'
str = str + 'Content-Type:text/csv\r\n\r\n'
str = str + strImportUser + '\r\n\r\n'
str = str + '--' + strBoundary + '--'
// リクエスト送信
xmlHttp.send(str);
// リクエスト受け取り
if (xmlHttp.status == 200){
if(window.JSON){
var obj = JSON.parse(xmlHttp.responseText);
}
}
====================
<リクエストボディ>
====================
"-----------------------------UbpbI3VKkpTFmdxDZgXz78aVFOmW79EAFeDW\r\n
Content-Disposition: form-data; name=\"file\"; filename=\"user.csv\"\r\n
Content-Type:text/csv\r\n
\r\n
aaa,ユーザ表示名,aaa,*,,,,,,ja,,1,ja,Asia/Tokyo,,,,,,,,,1,,,,2,,,,,\r\n
\r\n
-----------------------------UbpbI3VKkpTFmdxDZgXz78aVFOmW79EAFeDW--"
====================
<レスポンス>
====================
"{\"message\":\"不正なPOSTアクセスです。画面をリロードしてください。\",\"id\":\"1505999166-303074970\",\"code\":\"CB_CS01\"}"
====================
以上です。
上澤 嘉照さま
いつもお世話になっております。cybozu.com developer network事務局です。
ご質問いただきありがとうございます。
各ページでコメントもしていただけるのですが、こちらの「コミュニティで尋ねよう」からぜひご投稿ください。
コミュニティ内の方も投稿に気づきやすいです。
https://cybozudev.zendesk.com/hc/ja/community/topics
今回いただいたご質問内容ですと下のJavaScriptカスタマイズフォーラムカテゴリになります。
https://cybozudev.zendesk.com/hc/ja/community/topics/200034345-JavaScript-%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%9E%E3%82%A4%E3%82%BA-%E3%83%95%E3%82%A9%E3%83%BC%E3%83%A9%E3%83%A0
お手数ですが、よろしくお願いいたします。
kintone.app.record.getHeaderMenuSpaceElement の説明が誤っているように思います。
見出しと返り値の説明では「メニューの右側の空白部分の要素を取得する」となっていますが、
画像の通り「メニューの上側の空白部分の要素を取得する」が正しいと思います。
植村 知之さま
いつもお世話になっております。cybozu.com developer network事務局です。
該当箇所を修正致しました。ご確認ください。
ご指摘いただきありがとうございます。
いつもお世話になっております。
レコード詳細・追加・編集の画面で、画面上部のposition: fixed になっているフローター要素を取得する関数の追加予定はありますでしょうか。
(現状、ツールバーや編集ボタンが配置されているエリアです)
khosokai 様
いつもお世話になっております。
cybozu.com developer network事務局です。
> レコード詳細・追加・編集の画面で、画面上部のposition: fixed になっている
下記の部分でよろしいでしょうか?

こちらの部分に関しては、現時点では、追加の予定はございません。
ご希望に沿えず申し訳ございません。
> (現状、ツールバーや編集ボタンが配置されているエリアです)
上記のヘッダー部分ではなく、詳細画面などで表示される下記のツールバー部分の場合、

黄色で囲んだ部分については、現時点では、追加の予定はございません。
赤く囲んだ部分はこの記事の「メニューの上側の空白部分の要素を取得する」に記載している内容で取得可能ですので、申し訳ございませんが、
そちらをご利用ください。
よろしくお願い致します。
お世話になっております。
わかりづらい質問で大変失礼致しました。
上記でご提示頂いた、黄色枠部分についての確認でした。
また、追加の予定がない旨、承知致しました。
丁寧なご回答ありがとうございます。
よろしくお願い致します。
お世話になります。
ルックアップフィールドの参照先アプリIDの取得ができるのはありがたいのですが参照しているレコードのID取得がここにないのはなぜなんでしょうか?
tanaka様
お世話になっております。developer network 運営チームです。
ルックアップフィールドの参照先レコードIDを直接取得するAPIはございません。
ご希望に添えず申し訳ございません。
参照先レコードに関して処理を行う場合は、ルックアップフィールドの値(キー)を取得していただき、
その値を元に レコードの一括取得(クエリで条件を指定)API をご利用ください。
今後ともよろしくお願いいたします。
cybozu Development team様
返信ありがとうございます。
やはりありませんか、レコードページのURLにレコード番号が含まれてることと
ルックアップフィールドの値をクリックすることでレコードが開ことからもしかしたらと思って質問させていただきました。
お答えいただきありがとうございます。