API Updates for May 2021
API Updates
The next Kintone update is 10th May 2021. The release also includes the following API updates.
Update Summary
The May updates for the Kintone platform include features to show/hide widgets in
Spaces
. Due to this, API updates for May include new features and enhancements related to these feature updates.
Kintone JavaScript API
New Features
- The Onload Events for Spaces will trigger at a new timing.
- Relevant APIs
-
Desktop Onload Event
(
space.portal.show
) -
Mobile Onload Event
(
mobile.space.portal.show
)
-
Desktop Onload Event
(
- Details
- Before the update: The event triggers after all widgets are rendered.
- After the update: The event will trigger after all non-hidden widgets are rendered.
- Relevant APIs
Enhanced Features
-
JavaScript APIs that create URLs from shortened paths will be enhanced to take in paths ending in ".json".
- Relevant APIs
-
Get URL
kintone.api.url()
-
Get URL with query
kintone.api.urlForGet()
-
Get URL
- Relevant APIs
-
Details
As an example, kintone.api.url('/k/v1/records.json') produces the following results:- Before the update: https://{subdomain}.kintone.com/k/v1/record.json.json
- After the update: https://{subdomain}.kintone.com/k/v1/record.json
-
Notes
- The
Kintone REST API Request
will also be able to process requests where the path is stated with a ".json".
e.g. kintone.api('/k/v1/record.json', 'GET', ... )
- The
Kintone REST API Request
will also be able to process requests where the path is stated with a ".json".
Kintone REST API
New Features
- Additional parameters will be added to the response of the Get Space API.
- Relevant APIs
- Get Space (/v1/space.json)
- Details
- The additional parameters below represent the display status of the Space widgets:
- showAnnouncement: The "Announcement" widget
- showAppList: The "Apps" widget
- showMemberList: The "People" widget
- showThreadList: The "Threads" widget
- showRelatedLinkList: The "Related Apps & Spaces" widget
- The additional parameters below represent the display status of the Space widgets:
- Notes
- The display status is available for Spaces with the "Enable multiple threads" option turned on.
- Single-threaded spaces will respond with
null
in these parameters.
- Relevant APIs