ActionSettings
Provides full access to the action rules that automate record creation or updates across Kintone apps, allowing administrators to audit or adjust how cross-app workflows operate.
Select
The AppId column is required in the WHERE clause. The add-in will use the Kintone APIs to filter the results by this column. By default, the add-in will process other filters client-side within the add-in.
For example, the following queries are processed server side:
SELECT * FROM ActionSettings WHERE AppId = 6 SELECT * FROM ActionSettings WHERE AppId = 6 AND Lang = 'en' SELECT * FROM ActionSettings WHERE AppId = 6 AND IsPreview = false
Update
For updating the ActionSettings, provide the Actions as an aggregate. The AppId column is required to update the ActionSettings.
UPDATE ActionSettings SET Actions = '{"Action_Z":{"name":"Action_A","index":"0"}}' WHERE AppId = 6
Columns
| Name | Type | ReadOnly | References | Description |
| AppId | Integer | False |
Identifier of the Kintone app whose action settings are being retrieved or updated. | |
| Id [KEY] | String | True |
Unique identifier of the action, used to reference or update a specific automation rule. | |
| Index | String | False |
Zero-based position of the action within the app's action list, reflecting the order in which actions are displayed. | |
| Name | String | False |
Name assigned to the action, typically used to describe its purpose within the app's workflow. | |
| DestApp | String | False |
Identifier of the destination app where records are copied when the action is executed. | |
| DestCode | String | False |
App code of the destination app, with an empty string returned when no app code is configured in that app's settings. | |
| Mappings | String | False |
Array of objects that define field mapping settings for the action, with an empty array returned when no mappings are configured. | |
| Entities | String | False |
Array of objects listing the users, groups, or departments that are allowed to use the action, excluding inactive or deleted entities. | |
| Revision | String | False |
Revision number of the app settings, allowing you to track configuration versions during updates. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Lang | String |
Locale code used to retrieve action settings in a specific language. |
| IsPreview | Boolean |
Indicates whether to retrieve action settings from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
| Actions | String |
Value used only when performing an update to supply modified action settings. |