API Updates for July 2019
API Updates
The next Kintone update is 12th July 2019. The release also includes the following updates.
Kintone JavaScript API
New features
- New API
With the addition of the portal customization feature, the following APIs will be added.- Portal Onload Event (
portal.show
andmobile.portal.show
)- Details:
- An event triggered when the portal is displayed on either desktop or mobile. Triggered after portal widgets are displayed. Is not triggered within Guest User portals (both desktop and mobile).
- Details:
- Get Portal Content Space Element (
kintone.portal.getContentSpaceElement()
andkintone.mobile.portal.getContentSpaceElement()
)- Details:
- Retrieve the space element above the contents of the portal on desktop or mobile.
- Details:
- Portal Onload Event (
- Automatically run a Lookup field by specifying UPDATE
- Relevant APIs:
-
Record Create Onload Event
(
app.record.create.show
andmobile.app.record.create.show
) -
Record Create Field Change Event
(
app.record.create.change.(fieldcode)
andmobile.app.record.create.change.(fieldcode)
) -
Record Edit Onload Event
(
app.record.edit.show
andmobile.app.record.edit.show
) -
Record Edit Field Change Event
(
app.record.edit.change.(fieldcode)
andmobile.app.record.edit.change.(fieldcode)
) -
Set Record Value
(
kintone.app.record.set()
andkintone.mobile.app.record.set()
)
-
Record Create Onload Event
(
- Feature details:
- Specifying UPDATE in the lookup property of a Lookup field in the event object will automatically run the lookup in the above events and method.
(This is the same operation as previously specifyingtrue
in the lookup property of the desktop versions.)
- Specifying UPDATE in the lookup property of a Lookup field in the event object will automatically run the lookup in the above events and method.
- Relevant APIs:
- Clear the copied values of a Lookup field by specifying CLEAR
- Relevant APIs:
-
Record Create Onload Event
(
app.record.create.show
andmobile.app.record.create.show
) -
Record Create Field Change Event
(
app.record.create.change.(fieldcode)
andmobile.app.record.create.change.(fieldcode)
) -
Record Edit Onload Event
(
app.record.edit.show
andmobile.app.record.edit.show
) -
Record Edit Field Change Event
(
app.record.edit.change.(fieldcode)
andmobile.app.record.edit.change.(fieldcode)
) -
Set Record Value
(
kintone.app.record.set()
andkintone.mobile.app.record.set()
)
-
Record Create Onload Event
(
- Feature details:
- Specifying CLEAR in the lookup property of a Lookup field in the event object will clear the copied values of the Lookup field.
- Relevant APIs:
Spec changes
- The mobile Date and Datetime fields will be updated to use a calendar picker. In relation to this update, the following specs will be changed.
- The value set in a Date or Datetime field that is specified in the event object returned in the mobile Field Change event
- Relevant APIs:
-
Record Create Field Change Event
(
mobile.app.record.create.change.(fieldcode)
) -
Record Edit Field Change Event
(
mobile.app.record.edit.change.(fieldcode)
)
-
Record Create Field Change Event
(
- Spec change details:
When a mobile Field Change event that includes an empty Date or Datetime field in the event object has its event returned, and a value is specified for the Date or Datetime field:- Before the change:
- The specified value is cleared.
- After the change:
- The specified value is not cleared and is set successfully.
- Before the change:
- Relevant APIs:
- The value set in a Date or Datetime field that is specified in the event object returned in the mobile Field Change event
Kintone REST API
New features
- New APIs
- The following APIs have been added to optimize the rapid retrieval of a large number of records from an App.
- Add Cursor (POST
/k/v1/records/cursor.json
)- Adds a database cursor based on a query string. Responds a cursor ID.
- The maximum number of active cursors a subdomain may have is 10.
- Get Cursor (GET
/k/v1/records/cursor.json
)- Retrieves records from the cursor, by specifying the cursor ID. If all records are retrieved from the cursor, the cursor is automatically deleted.
- Delete Cursor (DELETE
/k/v1/records/cursor.json
)- Deletes a cursor by specifying the cursor ID.
- Add Cursor (POST
- The following APIs have been added to optimize the rapid retrieval of a large number of records from an App.
Bug fixes
- A bug exists where under specific conditions when an API token is used to add a record, the request becomes an invalid request and the record is not added. This bug will be fixed in the July update.
- Relevant APIs:
-
Add Record
(POST
/k/v1/record.json
) -
Add Records
(POST
/k/v1/records.json
)
-
Add Record
(POST
- Bug fix details:
When a record is added to an App using an API token and the following conditions are present, the request becomes an invalid request and the record is not added. After the update, the error will not be shown and the record will be added.- Conditions: 1. View permissions are set for the field that is being used as the Title Field of an App, where the users that are affected by the permissions are determined by a different field in the same App (such as a User Selection field). 2. General Notifications are set.
- Before the fix:
- The invalid request error is shown and the record is not added.
- After the fix:
- No error is shown and the record is added.
- Relevant APIs:
Other updates
- The Get Form API will be deprecated.
- Relevant APIs:
- Get Form GET /k/v1/form.json
- Get Form Preview GET /v1/preview/form.json
- Update details:
- The Get Form API will be deprecated.
The official date of deprecation will be announced in the future. Please change any customization codes using this API to the Get Form Fields (/v1/form/fields.json
) API or the Get Form Layout (/v1/form/layout.json
) API. The Kintone Config Helper library can also be used to retrieve App form data.
- The Get Form API will be deprecated.
- Relevant APIs:
User API
New features
- New APIs
- The Add, Update, and Delete Departments APIs will be added.
- Add Departments (POST
/v1/organizations.json
)- Adds multiple departments to a Kintone environment..
- Can only be used by Administrators.
- Update Departments (PUT
/v1/organizations.json
)- Updates multiple departments of a Kintone environment.
- Can only be used by Administrators.
- Delete Departments (DELETE
/v1/organizations.json
)- Deletes multiple departments from a Kintone environment.
- Can only be used by Administrators.
- Add Departments (POST
- The Update Department Code API will be added.
- Update Department Codes PUT (
/v1/organizations/codes.json
)- Updates codes of multiple departments.
- Can only be used by Administrators.
- Update Department Codes PUT (
- The Add, Update, and Delete Departments APIs will be added.