API Updates for July 2019

The next Kintone update is 12th July 2019. The release also includes the following updates.

Kintone JavaScript API

New Features

New APIs

With the addition of the portal customization feature, the following APIs will be added.

  • Portal Onload Event
    portal.show / mobile.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).
  • Get Portal Content Space Element
    kintone.portal.getContentSpaceElement() / kintone.mobile.portal.getContentSpaceElement()

    • Details:
      • Retrieve the space element above the contents of the portal on desktop or mobile.

Automatically run a Lookup field by specifying UPDATE

  • 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 specifying true in the lookup property of the desktop versions.)

Clear the copied values of a Lookup field by specifying CLEAR

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:

    • 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.

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.

Bug Fix

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:

  • 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.

Other Updates

The Get Form API will be deprecated.

  • Relevant APIs:

  • 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 (form/fields.json) API or the Get Form Layout (form/layout.json) API. The Kintone Config Helper library can also be used to retrieve App form data.

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.

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.
Was this article helpful?
0 out of 0 found this helpful
Do you have any questions or issues related to this article?
Please share your views with us in the Community forums!