Customize

When Kintone API Failed

Summary

Trigger an action when the Kintone REST API, called from the Customine customization, encounters an error.

How to use

This is used when an action invokes the Kintone REST API during customization, and to execute a different action if the Kintone REST API call fails.

Examples of actions that call Kintone’s REST API include “Add New Record” and “Change Status on Specified Records.”

A common use case involves customizing the system to perform operations on other records Before Record Saved Excluding Deleted. If an error occurs during this operation, you may want to cancel the save action. To do this, you can set the action to “Cancel Save of Record” under the condition “When Kintone API Failed.”

Parameters

There are no parameters to be set.

Restrictions

  • The condition “When Kintone API Failed” does not occur in the following cases:

    • When the Kintone REST API called using “Execute JavaScript” encounters an error
    • When the Kintone REST API called from JavaScript that is not Customine (plugins or custom JavaScript) encounters an error
    • When errors occur while clicking “Save” on the record edit or new record page—specifically due to standard Kintone operations
    • If an error is encountered during the error check from Customine’s “Error Check” category

  • In these situations, a message dialog will be displayed to notify the end user of the error. This dialog cannot be hidden, even if “When Kintone API Failed” is used. Additionally, executing an action to display a dialog, like “Display Error Dialog,” will not display the dialog above. This is because the dialog that notifies the user of the Kintone API error takes priority.