2021年5月9日kintone APIアップデート情報
2021年5月9日に実施するメンテナンスにおける、kintone APIのアップデート内容は次のとおりです。
今月のkintoneアップデート情報
5月版のスペーストップ画面のウィジェットを非表示に設定できる機能により、不要なウィジェットを非表示にしてオリジナルのコンテンツを表示させるカスタマイズが行えます。
また、これに伴い、一部のAPIやイベントにもウィジェットの非表示への対応が行われます。
kintone JavaScript API
機能追加
5月版でスペースの各ウィジェットを非表示に設定できます。それに伴い、以下の対応が行われます。
スペースのトップ画面の表示イベントの発行タイミングが、「すべてのウィジェットの描画完了後」から「すべての非表示ではないウィジェットの描画完了後」に変更されます
対象API
スペースのトップ画面を表示した後のイベント
- space.portal.show
mobile.space.portal.show
備考
5月の定期メンテナンスで、スペースのトップ画面の各ウィジェットの表示設定(モバイルの場合はタブ)を変更できます。
機能改善
省略した形式のAPIのパスからURLを生成するJavaScript APIで、指定したパスにかかわらず、必ず「.json」が付与されていた挙動を改善しました
対象API
-
APIのURLを取得する
-
kintone.api.url()
-
クエリ文字列付きのAPIのURLを取得する
-
kintone.api.urlForGet()
修正内容
kintone.api.url('/k/v1/records.json')
の場合
- 変更前
- https://example.cybozu.com/k/v1/record.json.json が生成される。
- 変更後
- https://example.cybozu.com/k/v1/record.json が生成される。
今回の改善に関する影響
kintone.api.url('/k/v1/records')
のように「.json」を省略してパスを指定している場合、今回の改善に対する影響はありません。
これらのAPIでは、本来「.json」が付くパスは指定できない仕様でした。
「.json」を付けたURLを指定すると、末尾にさらに「.json」が付与したURLを返していました。
今後は「.json」を付けたURLを指定した場合、新たに「.json」を付与することはなくなります。
これらのAPIを使って、「.json.json」といった末尾のURLを取得してREST APIを実行していないか、あらためて確認してください。
備考
この改善伴って、
kintone REST APIリクエストを送信するAPI
でも、「.json」を付けたkintone REST APIのパスを指定して実行できます。
例:kintone.api('/k/v1/record.json', 'GET', ... )
kintone REST API
機能追加
5月版でスペースの各ウィジェットを非表示に設定できます。それに伴い、以下の対応が行われます。
スペース情報の取得APIにウィジェットの表示状態に関するパラメーターが追加されます
これらの表示状態は、「スペースのポータルと複数のスレッドを使用する」が有効のスペースでのみ取得できます。
対象API
スペースの情報を取得する
- /k/v1/space.json
備考
レスポンスパラメーターに以下のパラメーターが追加されます。
showAnnouncement
:「お知らせ」の表示状態showAppList
:「アプリ一覧」の表示状態showMemberList
:「メンバー一覧」の表示状態showThreadList
:「スレッド一覧」の表示状態showRelatedLinkList
:「関連リンク一覧」の表示状態
製品のアップデート情報
API以外のkintoneのアップデートに関する情報は、
kintoneアップデート情報
を参照してください。
5月定期メンテナンス分は後日公開されます。