2019年7月14日の定期メンテナンスの、kintone API および User API の更新に関する情報をお知らせします。
お知らせの内容に追加、変更等ありましたら、こちらのコメントにて変更箇所を追記します。
また、APIドキュメントには仕様を順次公開していきます。
kintone JavaScript API
機能追加
- 新規 API 追加
ポータルカスタマイズ機能の追加に伴い、以下の API が追加されます。- ポータル画面を開いたときのイベント
portal.show / mobile.portal.show
- 内容:
PC 版およびスマートフォン版でポータル画面を開いたときに発生するイベントです。
表示対象に設定されているウィジェットがすべて描画されたあとに発生します。
ゲストユーザーのポータル画面(/k/guest/#/portal および /k/guest/m/)では発生しません。
- 内容:
- ポータルのコンテンツ上部の空白部分の要素を取得する
kintone.portal.getContentSpaceElement() / kintone.mobile.portal.getContentSpaceElement()- 内容:
PC 版およびスマートフォン版で、ポータルのコンテンツ上部の空白部分の要素を取得します。
- 内容:
- ポータル画面を開いたときのイベント
- 「ルックアップ」フィールドの lookup プロパティに 'UPDATE' を指定すると、ルックアップの取得を自動で行う
- 対象API
- レコード追加画面が表示された時のイベント
app.record.create.show / mobile.app.record.create.show - レコード追加画面のフィールド値変更時イベント
app.record.create.change.<フィールドコード> / mobile.app.record.create.change.<フィールドコード> - レコード編集画面が表示された時のイベント
app.record.edit.show / mobile.app.record.edit.show - レコード編集画面のフィールド値変更時イベント
app.record.edit.change.<フィールドコード> / mobile.app.record.edit.change.<フィールドコード> - レコードに値をセットする
kintone.app.record.set() / kintone.mobile.app.record.set()
- レコード追加画面が表示された時のイベント
- 内容:
PC 版およびスマートフォン版で「ルックアップ」フィールドの lookup プロパティに 'UPDATE' を指定すると、ルックアップの取得を自動で行います。
(PC 版で lookup プロパティに true を指定したときと同じ挙動です)
- 対象API
- 「ルックアップ」フィールドの lookup プロパティに 'CLEAR' を指定すると、コピー先のフィールドの値をクリアする
- 対象API
- レコード追加画面が表示された時のイベント
app.record.create.show / mobile.app.record.create.show - レコード追加画面のフィールド値変更時イベント
app.record.create.change.<フィールドコード> / mobile.app.record.create.change.<フィールドコード> - レコード編集画面が表示された時のイベント
app.record.edit.show / mobile.app.record.edit.show - レコード編集画面のフィールド値変更時イベント
app.record.edit.change.<フィールドコード> / mobile.app.record.edit.change.<フィールドコード> - レコードに値をセットする
kintone.app.record.set() / kintone.mobile.app.record.set()
- レコード追加画面が表示された時のイベント
- 内容:
PC 版およびスマートフォン版で、「ルックアップ」フィールドの lookup プロパティに 'CLEAR' を指定すると、コピー先のフィールドの値を空にします。
- 対象API
仕様変更
スマートフォン版の「日付」「日時」フィールドの UI がカレンダーピッカーに変更されます。それに伴い、以下の仕様が変更されます。
- スマートフォンの「日付」「日時」に対するフィールド値変更時イベントで return event したときの、値変更イベントに指定した「日付」「日時」フィールドに設定される値
- 対象API
- レコード追加画面のフィールド値変更時イベント mobile.app.record.create.change.<フィールドコード>
- レコード編集画面のフィールド値変更時イベント mobile.app.record.edit.change.<フィールドコード>
- 内容:
スマートフォンの「日付」「日時」に対する値の変更時イベントで「return event」を実行する場合、値変更イベントに指定したフィールドで、値が未入力の状態から日付または日時を指定したとき- 変更前:
指定フィールドの値がクリアされる。 - 変更後:
指定フィールドの値がクリアされず、指定した値が設定される。
- 変更前:
- 対象API
kintone REST API
機能追加
- 新規 API 追加
大量のレコードを高速に取得するため、以下の API が追加されます。- カーソルを作成する
POST /k/v1/records/cursor.json- 一度に取得するレコードサイズや条件を指定し、カーソルを作成します。
- 有効にできるカーソル数は、1ドメインあたり10個までです。
- カーソルを使ってレコードを取得する
GET /k/v1/records/cursor.json
- 指定されたカーソルを使って、レコードを取得します。
- カーソルを削除する
DELETE /k/v1/records/cursor.json
- 指定したカーソル IDのカーソルを削除します。
- 有効期限後またはカーソルによる全レコード取得完了後にも、カーソルは自動で削除されます。
- カーソルを作成する
不具合修正
- 特定の条件下でAPI トークンを利用したレコード追加を行うと、不正なリクエストとなりレコードが追加されない現象を解消
その他告知
- フォーム設計情報取得 API 提供の廃止について
- 対象 API
- フォーム設計情報取得 GET /k/v1/form.json
- 開発中アプリのフォーム設計情報取得 GET /v1/preview/form.json
- 内容:
フォーム設計情報取得 API は今後廃止する予定です。廃止時期については利用状況を見ながら決定し、別途ご案内いたします。
フィールドの一覧を取得する(form/fields.json)およびフォームのレイアウトを取得する(form/layout.json)への移行をお願いいたします。
- 対象 API
User API
機能追加
- 新規 API 追加
組織インポート API(JSON)として、組織情報を追加・更新・削除する API が追加されます。- 組織情報の登録
POST /v1/organizations.json- 組織情報を JSON データで一括登録するための API です。
- .com 共通管理者のみ実行できます。
- 組織情報の更新
PUT /v1/organizations.json- 組織情報を JSON データで一括更新するための API です。
- .com 共通管理者のみ実行できます。
- 組織情報の削除
DELETE /v1/organizations.json- 組織情報を JSON データで一括削除するための API です。
- .com 共通管理者のみ実行できます。
組織コードインポート API(JSON)として、組織コードを更新する API が追加されます。- 組織コードの更新
PUT /v1/organizations/codes.json- 組織のコードを JSON データで一括更新するための API です。
- .com 共通管理者のみ実行できます。
- 組織情報の登録
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。