The CData Sync App provides a straightforward way to continuously pipeline your Kintone data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Kintone connector can be used from the CData Sync application to pull data from Kintone and move it to any of the supported destinations.
The Sync App models the Kintone REST APIs as a relational database.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
In addition to the authentication values, set the following parameters to connect to and retrieve data from Kintone:
Set Schema to "Kintone" for connecting to Kintone REST API.
Kintone REST API supports following authentication schemes:
Set Schema to "CybozuUser" for connecting to Kintone USER API.
Kintone USER API supports following authentication scheme:
Kintone supports the following authentication methods.
You must set the following to authenticate to Kintone:
You must set the following to authenticate to Kintone:
To generate an API token access the specific app and click on the cog wheel. Proceed to App Settings tab > API Token. Click on the Generate button, an API token will be generated. You can also specify multiple comma-seperated APITokens.
The AppId is the number of that specific app in the sequence under Apps in Kintone UI dashboard. You can also specify multiple comma-seperated AppIds.
In addition to the mentioned authentication schemese, Kintone offers additional security in the form of both an additional Basic Auth header, and an SSL Certificate.
In addition to your authentication information, Kintone may be configured to require an SSL certificate to accept requests. To do so, set the following:
Kintone environments using basic authentication will need to pass additional basic credentials. To do so, specify the following:
Note: OAuth authentication does not support cursor API. OAuth is not recommended for retrieving more than 10k rows.
The following subsections describe how to authenticate to Kintone from three common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in Kintone, see Connection.
Automatic refresh of the OAuth access token:
To have the Sync App automatically refresh the OAuth access token:
Manual refresh of the OAuth access token:
The only value needed to manually refresh the OAuth access token is the OAuth refresh token.
Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.
This section details a selection of advanced features of the Kintone Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
See Kintone Data Model for the available entities in the Kintone Data Model.
See CybozuUser Data Model for the available entities in the CybozuUSER Data Model.
The Sync App models the Kintone REST API as relational Tables, Views and Stored Procedures.
Using the Sync App, you can work with all the tables in your account. The table schemas can be static or dynamic. The Comments table has a static schema with fixed columns, while other tables are dynamic, reflecting changes in the metadata -- when you connect, the Sync App retrieves table metadata from Kintone to generate the table schemas.
Static schemas are defined in schema files, which makes them easy to extend. Edit the schema file to customize the column behavior of the static Comments table, to change the data type for example. The schema files are located in the db subfolder of the Sync App installation folder.
In some Kintone apps, the user can add custom fields containing many records. The Sync App models these fields as dynamic subtables reflecting your changes.
Stored procedures are function-like interfaces to Kintone. They can be used to search, update, and modify information in Kintone. For example, use stored procedures to execute operations on apps or work with files.
The Sync App models apps in the static Apps view.
The Sync App models the data in Kintone as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| 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. |
| AppPermissions | Manages app-level permissions that control whether users or groups can view, edit, or manage a Kintone app, supporting security reviews and role maintenance. |
| Comments | Retrieves user comments posted on app records, allowing teams to analyze collaboration activity or export conversation history to external reporting tools. |
| FieldPermissions | Manages fine-grained access rules for individual fields so administrators can enforce data visibility and edit restrictions at the field level. |
| FormFields | Allows you to create, update, delete, and query app fields so you can manage an app's data model programmatically. |
| FormLayout | Exposes the structure of an app's form layout, allowing you to review or update how sections, fields, and elements are arranged for end users. |
| GeneralNotifications | Controls global notification settings for an app, allowing you to adjust how users are alerted about updates, mentions, or record activity. |
| GeneralSettings | Provides access to an app's high-level configuration such as name, icon, and operational behavior, supporting version control and configuration audits. |
| GraphSettings | Manages the charts and analytics defined inside an app so administrators can review or update how data is visualized for users. |
| PerRecordNotifications | Maintains notification rules tied to individual records, helping you automate alerts based on deadlines, conditions, or workflow changes. |
| ProcessManagement | Controls the workflow rules that govern how records move through states, allowing administrators to manage process steps, transitions, and restrictions. |
| RecordPermissions | Defines record-level access policies that determine who can view, modify, delete, or reassign a record, supporting compliance and security reviews. |
| ReminderNotifications | Controls reminder rules that trigger alerts based on time or conditions, allowing teams to track deadlines or follow-ups more reliably. |
| SampleApp | Represents the sample Customer Management app from the Sales Support Pack, useful for testing integration scenarios or exploring Kintone functionality. |
| SampleApp_Table | Provides the detail records that belong to the sample Customer Management app so you can explore relational behavior in the Sales Support Pack. |
| Space.rsd | Indicates whether the membership of the Space is fixed, preventing members from being added or removed outside of administrator settings. |
| SpaceMembers | Manages the membership lists of Spaces so you can review or update which users have access to a workspace and its discussions. |
| Views | Controls the app views that define filtered, sorted, or custom-formatted record lists, supporting administration of user-facing data presentations. |
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.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
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
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
| 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 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. |
Manages app-level permissions that control whether users or groups can view, edit, or manage a Kintone app, supporting security reviews and role maintenance.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM AppPermissions WHERE AppId = 6 SELECT * FROM AppPermissions WHERE AppId = 6 AND IsPreview = false
For updating the AppPermissions, provide the Rights as an aggregate. The AppId and IsPreview columns are required to update the AppPermissions.
UPDATE AppPermissions SET Rights = '[{"entity":{"type":"CREATOR"},"appEditable":true,"recordViewable":true,"recordAddable":true,"recordEditable":true,"recordDeletable":true,"recordImportable":true,"recordExportable":true}]' WHERE AppId = 6 AND IsPreview = true
| Name | Type | ReadOnly | References | Description |
| AppId [KEY] | Integer | False |
Identifier of the Kintone app whose permission settings are being retrieved or updated. | |
| EntityType [KEY] | String | False |
Type of entity to which the permission applies, such as a user, group, or department. | |
| EntityCode | String | False |
Code identifying the entity that receives the permission, used to match users, groups, or departments. | |
| IncludeSubs | Boolean | False |
Indicates whether permissions granted to a department also apply to its subordinate departments. | |
| AppEditable | Boolean | False |
Specifies whether the entity can manage the app by accessing and modifying its settings. | |
| RecordViewable | Boolean | False |
Specifies whether the entity is allowed to view records in the app. | |
| RecordAddable | Boolean | False |
Specifies whether the entity is permitted to add new records to the app. | |
| RecordEditable | Boolean | False |
Specifies whether the entity can edit existing records in the app. | |
| RecordDeletable | Boolean | False |
Specifies whether the entity is allowed to delete records from the app. | |
| RecordImportable | Boolean | False |
Specifies whether the entity can import records into the app using file-based operations. | |
| RecordExportable | Boolean | False |
Specifies whether the entity can export records from the app for external use or backup. | |
| Revision | String | True |
Revision number of the app settings, helping track permission changes over time. |
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 |
| IsPreview | Boolean |
Indicates whether to retrieve permission settings from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
| Rights | String |
This value is used only when performing an update to supply modified permission settings. |
Retrieves user comments posted on app records, allowing teams to analyze collaboration activity or export conversation history to external reporting tools.
The RecordId and AppId columns are required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by these columns. The Kintone APIs also support filters on Id. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Comments WHERE RecordId = 1 AND AppId = 5 AND Id = 1
The AppId and RecordId columns are required in the INSERT statement.
INSERT INTO Comments (AppId, RecordId, Text, MentionsAggregate) VALUES (5, 1, 'To do', '[{"code": "Administrator","type": "USER"}]')
Comments can be deleted by issuing a DELETE statement and specifying the RecordId, AppId, and Id.
DELETE FROM Comments WHERE RecordId = 1 AND AppId = 5 AND Id = 1
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Identifier of the comment, used to uniquely reference the comment within the app and link it to related actions or metadata. | |
| AppId [KEY] | Integer | False |
Identifier of the app that contains the record on which the comment was posted, helping associate discussions with a specific application. | |
| RecordId [KEY] | Integer | False |
Identifier of the record that the comment belongs to, allowing you to trace conversations tied to individual data entries. | |
| Text | Longvarchar | False |
Full text of the comment, including any line feed characters used to preserve formatting or multi-line input. | |
| CreatorCode | String | True |
Login name of the user who created the comment, supporting auditing and user activity tracking. | |
| CreatorName | String | True |
Display name of the user who created the comment, used to present readable author information in interfaces or reports. | |
| CreatedAt | Datetime | True |
Date and time when the comment was created, providing a chronological reference for discussions and activity history. | |
| MentionsAggregate | String | False |
Array containing details about the users mentioned in the comment, enabling notifications and tracking of directed communication. |
Manages fine-grained access rules for individual fields so administrators can enforce data visibility and edit restrictions at the field level.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM FieldPermissions WHERE AppId = 6 SELECT * FROM FieldPermissions WHERE AppId = 6 AND IsPreview = false
For updating the FieldPermissions, provide the Rights as an aggregate. The AppId and IsPreview columns are required to update the FieldPermissions.
UPDATE FieldPermissions SET Rights = 'Update FieldPermissions set Rights='[{"code":"Updated_by","entities":[{"accessibility":"READ","entity":{"type":"GROUP","code":"everyone"}}]}]' WHERE AppId = 6 AND IsPreview = true
| Name | Type | ReadOnly | References | Description |
| AppId [KEY] | Integer | False |
Identifier of the Kintone app whose field-level permission settings are being retrieved or updated. | |
| Code [KEY] | String | False |
Field code identifying the specific field that has custom permission rules applied. | |
| Entities | String | False |
Array listing the users, groups, or departments that receive field-level permissions, ordered by priority to control how permissions are evaluated. | |
| Revision | String | True |
Revision number of the app settings, helping track updates to field-permission configurations. |
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 |
| IsPreview | Boolean |
Indicates whether to retrieve field-permission details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
| Rights | String |
Value used only when performing an update to supply modified field-permission settings. |
Allows you to create, update, delete, and query app fields so you can manage an app's data model programmatically.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM FormFields WHERE AppId = 6 SELECT * FROM FormFields WHERE AppId = 6 AND Lang = 'en' SELECT * FROM FormFields WHERE AppId = 6 AND IsPreview = false
The AppId, Type, Code and Label columns are required in the INSERT statement.
INSERT INTO FormFields (AppId, Type, Code, Label) VALUES (6, 'SINGLE_LINE_TEXT', 'Text__single_line_CRUD', 'Test')
Insertion can also be executed by providing the AppId column and Properties column as a json aggregate:
INSERT INTO FormFields (AppId, Properties) VALUES (6, '{"Text__single_line_TD":{"type":"SINGLE_LINE_TEXT","code":"Text__single_line_TD","label":"Test"}}')
The Kintone API supports Bulk Insert as well:
INSERT INTO FormFields#TEMP (AppId, Type, Code, Label) VALUES (6, 'SINGLE_LINE_TEXT', 'Text__single_line_temp1', 'Label1') INSERT INTO FormFields#TEMP (AppId, Type, Code, Label) VALUES (6, 'SINGLE_LINE_TEXT', 'Text__single_line_temp2', 'Label2') INSERT INTO FormFields (AppId, Type, Code, Label) SELECT AppId, Type, Code, Label FROM FormFields#TEMP
You can update FormFields in two different ways, depending on your use case:
Method 1: Update Using the Properties Column, If you want to update multiple form field details at once, you can use the Properties column. This column expects a JSON object that includes field attributes like code, label, and type etc. In this Method AppId column is required in where clause.
UPDATE FormFields SET Properties = '{"Text__single_line_TT":{"code":"Text__single_line_PT","label":"text","type":"SINGLE_LINE_TEXT"}}' WHERE AppId = 6
Method 2: Update Individual Columns, You can also update individual fields like label, code etc. directly without using the Properties column but this will update one field at a time. In this Method both AppId and Code columns are required in where clause.
UPDATE FormFields SET label='text', code='Item_update', type='SINGLE_LINE_TEXT' where appId=444 and code='Item';
You need to specify the comma separated values of Code column that you want to delete. The AppId Column is required to delete the FormFields.
DELETE FROM FormFields WHERE Code = 'Text__single_line_CRUD, Text__single_line_TD' AND AppId = 6
| Name | Type | ReadOnly | References | Description |
| AppId [KEY] | Integer | False |
Identifier of the Kintone app whose form-field configuration is being retrieved or updated. | |
| Code [KEY] | String | False |
Field code that uniquely identifies the form field within the app's schema. | |
| Enabled | String | True |
Indicates whether specific field features are enabled or disabled, helping control how the field behaves in the form. | |
| Label | String | False |
Display name shown for the field in the form layout. | |
| NoLabel | Boolean | False |
Indicates whether the field's label should be hidden in the form to create a cleaner or more compact layout. | |
| Type | String | False |
Field type used in the form, determining the data format and behavior for the field. | |
| Required | String | False |
Specifies whether the field must contain a value before a record can be saved. | |
| Unique | String | False |
Specifies whether duplicate values are prohibited for the field, enforcing uniqueness across records. | |
| MaxValue | String | False |
Maximum number of characters allowed for the field, helping control input length. | |
| MinValue | String | False |
Minimum number of characters required for the field to ensure sufficient input. | |
| MaxLength | String | False |
Maximum number of digits allowed for numeric fields to control the size of accepted numeric inputs. | |
| MinLength | String | False |
Minimum number of digits required for numeric fields to enforce minimal numeric input. | |
| DefaultValue | String | False |
Default value applied to the field, returned as an array when the field supports multiple default selections. | |
| DefaultNowValue | String | False |
Indicates whether the field should automatically populate with the record creation date. | |
| Options | String | False |
Object containing the field's selectable options, such as labels and values used in dropdowns or radio buttons. | |
| Align | String | False |
Layout alignment applied to option-based fields, affecting how choices are displayed to users. | |
| Expression | String | False |
Formula expression used to calculate the field's value dynamically. | |
| HideExpression | String | False |
Indicates whether the field's formula expression should be hidden from users in the form. | |
| Digit | String | False |
Indicates whether thousands separators should be used when displaying numeric values. | |
| ThumbnailSize | String | False |
Pixel size of image thumbnails shown for fields that store images. | |
| Protocol | String | False |
Link-type configuration defining how URLs or link fields behave when opened. | |
| Format | String | False |
Display format applied to calculated fields, such as formatting numbers or dates for readability. | |
| DisplayScale | String | False |
Number of decimal places to display for numeric fields when rendering values. | |
| Unit | String | False |
Currency unit displayed with the field when the field represents financial values. | |
| UnitPosition | String | False |
Position of the currency unit relative to the numeric value in the field's display. | |
| Entities | String | False |
Array listing the preset users assigned to the field, often used for default assignees or user picker initialization. | |
| ReferenceTable | String | False |
Object containing configuration details for a Related Records field, defining how linked records are retrieved and displayed. | |
| LookUp | String | False |
Object containing lookup field settings that define how values are pulled from another app's record. | |
| OpenGroup | String | False |
Indicates whether the field group should be expanded by default when the form loads. | |
| Fields | String | False |
Object containing nested field definitions for table fields, using the same parameters as the Properties structure. | |
| Revision | String | True |
Revision number of the app settings, helping track updates to the form configuration. |
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 form-field data in a specific language. |
| IsPreview | Boolean |
Indicates whether to retrieve form-field settings from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
| Properties | String |
Value used only when performing an insert or update to supply modified field definitions. |
Exposes the structure of an app's form layout, allowing you to review or update how sections, fields, and elements are arranged for end users.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM FormLayout WHERE AppId = 6 SELECT * FROM FormLayout WHERE AppId = 6 AND Lang = 'en' SELECT * FROM FormLayout WHERE AppId = 6 AND IsPreview = false
For updating the FormLayout, provide the Layout as an aggregate. All fields in the form must be specified in the aggregate. The AppId column is required to update the FormLayout.
UPDATE FormLayout SET Layout = '[{"type":"ROW","fields":[{"type":"SPACER","code":"Table_0","size":{"width":"200"}}]}]' WHERE AppId = 6
| Name | Type | ReadOnly | References | Description |
| AppId [KEY] | Integer | False |
Identifier of the Kintone app whose form layout configuration is being retrieved or updated. | |
| Fields | String | False |
List of fields contained in the layout row, representing the elements displayed together in that section of the form. | |
| Type | String | False |
Type of layout row, indicating how the row is structured and how its fields are arranged within the form. The allowed values are ROW, SUBTABLE, GROUP. | |
| Code | String | False |
Field code of the Table or Group field associated with the row, returned only when the row represents one of these container types. | |
| Revision | String | True |
Revision number of the app settings, helping track changes made to the form layout over time. |
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 |
| IsPreview | Boolean |
Indicates whether to retrieve form-layout details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
| Layout | String |
Value used only when performing an insert or update to supply modified layout definitions. |
Controls global notification settings for an app, allowing you to adjust how users are alerted about updates, mentions, or record activity.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM GeneralNotifications WHERE AppId = 6 SELECT * FROM GeneralNotifications WHERE AppId = 6 AND IsPreview = false
For updating the GeneralNotifications, provide the Notifications as an aggregate. The AppId column is required to update the GeneralNotifications.
UPDATE GeneralNotifications SET Notifications = '[{"entity":{"type":"FIELD_ENTITY","code":"Updated_by"},"includeSubs":false,"recordAdded":false,"commentAdded":true}],"notifyToCommenter":true' WHERE AppId = 6
| Name | Type | ReadOnly | References | Description |
| AppId [KEY] | Integer | False |
Identifier of the Kintone app whose general notification settings are being retrieved or updated. | |
| EntityType | String | False |
Type of entity that receives the general notifications, such as a user, group, or department. | |
| EntityCode [KEY] | String | False |
Code identifying the specific entity configured to receive general notifications. | |
| IncludeSubs | Boolean | False |
Indicates whether notification rules assigned to a department should also apply to its subordinate departments, and always returns 'false' unless notifications[].entity.type is set to ORGANIZATION or FIELD_ENTITY for a Department Selection field. | |
| RecordAdded | Boolean | False |
Specifies whether the entity should receive a notification whenever a new record is added to the app. | |
| RecordEdited | Boolean | False |
Specifies whether the entity should receive a notification when an existing record is edited. | |
| CommentAdded | Boolean | False |
Specifies whether the entity should receive a notification when a new comment is posted on a record. | |
| StatusChanged | Boolean | False |
Specifies whether the entity should receive a notification when a record's status changes within a workflow. | |
| FileImported | Boolean | False |
Specifies whether the entity should receive a notification when data is imported into the app using a file. | |
| NotifyToCommenter | Boolean | False |
Specifies whether all commenters on a record should be notified when a new comment is added, reflecting the Send updated comment notifications to all commenters setting. | |
| Revision | String | True |
Revision number of the app settings, helping track changes made to notification rules. |
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 |
| IsPreview | Boolean |
Indicates whether to retrieve general-notification details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
| Notifications | String |
Value used only when performing an update to supply modified general-notification settings. |
Provides access to an app's high-level configuration such as name, icon, and operational behavior, supporting version control and configuration audits.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM GeneralSettings WHERE AppId = 6 SELECT * FROM GeneralSettings WHERE AppId = 6 AND IsPreview = false
You must specify the AppId and IconKey of the GeneralSetting to update.
UPDATE GeneralSettings SET Name = 'UpdatedName', Description = 'Test Description', IconType = 'PRESET', IconKey = 'APP72' WHERE IconKey = 'APP72' AND AppId = 6
| Name | Type | ReadOnly | References | Description |
| AppId [KEY] | Integer | True |
Identifier of the Kintone app whose general settings are being retrieved or updated. | |
| IconKey [KEY] | String | False |
Key identifier of the app's icon, returned when the app uses one of Kintone's preset icons. | |
| IconType | String | False |
Specifies the type of icon used for the app, indicating whether the icon is a PRESET icon or an uploaded FILE. | |
| IconFile | String | False |
Object containing data for an uploaded icon file when a custom icon is used for the app. | |
| Name | String | False |
Display name of the app as shown in the Kintone interface. | |
| Description | Longvarchar | False |
HTML-formatted description of the app, often used to provide context or usage instructions to users. | |
| Theme | String | False |
Color theme applied to the app, controlling the visual styling of the app's header and interface accents. | |
| Revision | String | True |
Revision number of the app settings, helping track updates made to the app's configuration. | |
| TitleFieldSelectionMode | String | False |
Method used to determine which field becomes the record title, allowing either AUTO selection or MANUAL selection by the app designer. | |
| TitleFieldCode | String | False |
Field code of the field designated as the record title when MANUAL selection mode is used. | |
| EnableBulkDeletion | Boolean | False |
Indicates whether users are allowed to delete multiple records at once using the bulk deletion feature. | |
| EnableComments | Boolean | False |
Indicates whether commenting is enabled for the app, allowing users to post comments on records. | |
| EnableDuplicateRecord | Boolean | False |
Indicates whether users are allowed to duplicate existing records to create new ones more quickly. | |
| EnableThumbnails | Boolean | False |
Indicates whether thumbnails should be displayed for fields that support image previews. | |
| FirstMonthOfFiscalYear | Integer | False |
Specifies the first month of the fiscal year for the app, returned as a numeric month value. | |
| NumberPrecisionDecimalPlaces | Integer | False |
Specifies the number of decimal places to use when rounding numeric values. | |
| NumberPrecisionDigits | Integer | False |
Specifies the total number of digits to allow for numeric values, including integer and fractional parts. | |
| NumberPrecisionRoundingMode | String | False |
Rounding mode applied to numeric values, supporting HALF_EVEN, UP, or DOWN. | |
| EnableInlineRecordEditing | Boolean | False |
Indicates whether inline editing is enabled in the record list, allowing users to modify fields directly without opening the record. |
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 general setting values in a specific language. |
| IsPreview | Boolean |
Indicates whether to retrieve general-setting details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
Manages the charts and analytics defined inside an app so administrators can review or update how data is visualized for users.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM GraphSettings WHERE AppId = 6 SELECT * FROM GraphSettings WHERE AppId = 6 AND Lang = 'en' SELECT * FROM GraphSettings WHERE AppId = 6 AND IsPreview = false
For updating the GraphSettings, provide the Reports as an aggregate. The AppId column is required to update the GraphSettings.
UPDATE GraphSettings SET Reports = '{"Graph1":{"chartType":"BAR","chartMode":"PERCENTAGE","name":"Updated_Graph_Name","index":"0","groups":[{"code":"Created_by"}]}}' WHERE AppId = 6
| Name | Type | ReadOnly | References | Description |
| AppId | Integer | False |
Identifier of the Kintone app whose graph and reporting settings are being retrieved or updated. | |
| Id [KEY] | String | True |
Unique identifier of the graph configuration within the app. | |
| Index | String | False |
Zero-based position of the graph in the app's graph list, determining the order in which graphs appear to users. | |
| Name | String | False |
Display name of the graph, limited to 64 characters, and returned in the requested language when a lang parameter is provided. | |
| PeriodicReport | String | False |
Object containing the graph's periodic report settings, returned as 'null' when no periodic report has ever been configured. | |
| Sorts | String | False |
Array of objects defining the Sort by settings that determine how graph data is ordered. | |
| Aggregations | String | False |
Function settings used to aggregate field values, such as totals or counts, when generating the graph. | |
| ChartMode | String | False |
Display mode applied to the graph, determining how the chart is rendered in the interface. | |
| ChartType | String | False |
Chart type selected for the graph, such as bar, line, pie, or other supported visualization formats. | |
| FilterCond | String | False |
Record filter condition expressed in query-string format, reflecting the graph's Filter settings. | |
| Groups | String | False |
Function settings used for grouping records in the graph, defining how data is categorized during aggregation. | |
| Revision | String | True |
Revision number of the app settings, helping track updates made to graph configurations. |
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 graph-setting values in a specific language. |
| IsPreview | Boolean |
Indicates whether to retrieve graph-setting details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
| Reports | String |
Value used only when performing an update to supply modified graph-report settings. |
Maintains notification rules tied to individual records, helping you automate alerts based on deadlines, conditions, or workflow changes.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM PerRecordNotifications WHERE AppId = 6 SELECT * FROM PerRecordNotifications WHERE AppId = 6 AND Lang = 'en' SELECT * FROM PerRecordNotifications WHERE AppId = 6 AND IsPreview = false
For updating the PerRecordNotifications, provide the Notifications as an aggregate. The AppId column is required to update the PerRecordNotifications.
UPDATE PerRecordNotifications SET Notifications = '[{"filterCond":"Record_number = 18","title":"Test Title","targets":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}]' WHERE AppId = 6
| Name | Type | ReadOnly | References | Description |
| AppId [KEY] | Integer | False |
Identifier of the Kintone app whose per-record notification settings are being retrieved or updated. | |
| FilterCond | String | False |
Record filter condition expressed in query-string format, defining which records trigger the per-record notification. | |
| Title [KEY] | String | False |
Subject line used for the notification, corresponding to the Summary field that appears in the Kintone interface. | |
| Targets | String | False |
Array of objects listing the users, groups, or departments that receives the per-record notification. | |
| Revision | String | True |
Revision number of the app settings, helping track updates made to the notification configuration. |
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 per-record notification data in a specific language. |
| IsPreview | Boolean |
Indicates whether to retrieve per-record notification details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
| Notifications | String |
Value used only when performing an update to supply modified per-record notification settings. |
Controls the workflow rules that govern how records move through states, allowing administrators to manage process steps, transitions, and restrictions.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM ProcessManagement WHERE AppId = 6 SELECT * FROM ProcessManagement WHERE AppId = 6 AND Lang = 'en' SELECT * FROM ProcessManagement WHERE AppId = 6 AND IsPreview = false
For updating the ProcessManagement, provide the States and Actions as an aggregate. The AppId column is required to update the ProcessManagement.
UPDATE ProcessManagement SET Enable = true, States = '{"In progress":{"name":"In progress","index":"1","assignee":{"type":"ONE","entities":[]}},"Ready":{"name":"Ready","index":"3","assignee":{"type":"ONE","entities":[]}},"Completed":{"name":"Completed","index":"2","assignee":{"type":"ONE","entities":[]}},"Not started":{"name":"Not started","index":"0","assignee":{"type":"ONE","entities":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}}}', Actions = '[{"name":"Start","from":"Not started","to":"In progress","filterCond":""},{"name":"Complete","from":"Completed","to":"Completed","filterCond":""}]' WHERE AppId = 6
| Name | Type | ReadOnly | References | Description |
| AppId [KEY] | Integer | False |
Identifier of the Kintone app whose process-management configuration is being retrieved or updated. | |
| Enable | Boolean | False |
Indicates whether process management is enabled for the app, controlling whether records progress through defined workflow states. | |
| Actions | String | False |
Array containing the app's process-management actions in the same order shown in the user interface, with the value of 'null' returned when process management has never been enabled. | |
| Revision | String | True |
Revision number of the app settings, helping track updates made to the process-management configuration. | |
| Name | String | False |
Display name of the workflow status associated with the current process-management state. | |
| Index | String | False |
Ascending display order of the workflow status, determining its position relative to other statuses. | |
| AssigneeType | String | False |
Type of assignee list used for the status, defining how users or groups are selected to handle the workflow step. | |
| AssigneeEntities | String | False |
Array listing the assignees configured for the status, returned in the same order presented in the user interface. |
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 process-management details in a specific language. |
| IsPreview | Boolean |
Indicates whether to retrieve process-management details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
| States | String |
Value used only when performing an update to supply modified process-management state definitions. |
Defines record-level access policies that determine who can view, modify, delete, or reassign a record, supporting compliance and security reviews.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM RecordPermissions WHERE AppId = 6 SELECT * FROM RecordPermissions WHERE AppId = 6 AND Lang = 'en' SELECT * FROM RecordPermissions WHERE AppId = 6 AND IsPreview = false
For updating the AppPermissions, provide the Rights as an aggregate. The AppId and IsPreview columns are required to update the RecordPermissions.
UPDATE RecordPermissions SET Rights = '[{"filterCond":"","entities":[{"entity":{"type":"GROUP","code":"everyone"},"viewable":false,"editable":false,"deletable":false,"includeSubs":true}]}]' WHERE AppId = 6 AND IsPreview = true
| Name | Type | ReadOnly | References | Description |
| AppId [KEY] | Integer | False |
Identifier of the Kintone app whose record-level permission settings are being retrieved or updated. | |
| FilterCond | String | False |
Filter condition expressed in query-string format that determines which records the permission rule applies to. | |
| Entities | String | False |
Array listing the users, groups, or departments that receive the record-level permissions, ordered by priority to control how permissions are evaluated. | |
| Revision | String | False |
Revision number of the app settings, helping track updates to record-permission configurations. |
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 record-permission details in a specific language. |
| IsPreview | Boolean |
Indicates whether to retrieve record-permission details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
| Rights | String |
Value used only when performing an update to supply modified record-permission settings. |
Controls reminder rules that trigger alerts based on time or conditions, allowing teams to track deadlines or follow-ups more reliably.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM ReminderNotifications WHERE AppId = 6 SELECT * FROM ReminderNotifications WHERE AppId = 6 AND Lang = 'en' SELECT * FROM ReminderNotifications WHERE AppId = 6 AND IsPreview = false
For updating the ReminderNotifications, provide the Notifications as an aggregate. The AppId column is required to update the ReminderNotifications.
UPDATE ReminderNotifications SET Notifications = '[{"timing":{"code":"Updated_datetime","daysLater":-2,"hoursLater":-5},"filterCond":"Record_number = 14","title":"Reminder: Tomorrow is the deadline.","targets":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}]' WHERE AppId = 6
| Name | Type | ReadOnly | References | Description |
| AppId [KEY] | Integer | False |
Identifier of the Kintone app whose reminder-notification settings are being retrieved or updated. | |
| FilterCond | String | False |
Record filter condition expressed in query-string format, defining which records trigger the reminder notification. | |
| Title | String | False |
Subject line used for the reminder notification, corresponding to the Summary field shown in the Kintone interface. | |
| TimingCode [KEY] | String | False |
Field code of the date or datetime field that determines when the reminder notification should be triggered. | |
| TimingDaysLater | Integer | False |
Number of days offset from the value in the timing field, where positive values schedule the reminder after that date and negative values schedule it before that date. | |
| TimingHoursLater | Integer | False |
Number of hours offset from the timing field's datetime value, applied after the day offset defined by TimingDaysLater. | |
| TimingTime | String | False |
Specific time of day when the reminder notification should be sent, returned when the timing field is a date field or when time-based scheduling is configured. | |
| Targets | String | False |
Array of objects listing the users, groups, or departments that receive the reminder notification. | |
| Revision | String | True |
Revision number of the app settings, helping track changes to the reminder-notification configuration. | |
| Timezone | String | False |
Time zone used to determine when reminder notifications are sent, reflecting the Reminder Time Zone setting and returning null when no reminder configuration exists. |
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 reminder-notification details in a specific language. |
| IsPreview | Boolean |
Indicates whether to retrieve reminder-notification details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
| Notifications | String |
Value used only when performing an update to supply modified reminder-notification settings. |
Represents the sample Customer Management app from the Sales Support Pack, useful for testing integration scenarios or exploring Kintone functionality.
| Name | Type | ReadOnly | References | Description |
| RecordId | Int | True |
Identifier of the sample record, used to reference or retrieve the entry within the sample app. | |
| Revision | Int | True |
Revision number of the sample record, indicating how many times the entry has been updated. | |
| AppId | Int | True |
Identifier of the sample app from which the record originates. | |
| Remarks | String | True |
Free-text remarks associated with the sample record, typically used for notes or comments. | |
| UpdaterCode | String | True |
Login name of the user who last updated the sample record. | |
| UpdaterName | String | True |
Display name of the user who last updated the sample record. | |
| CreatorCode | String | True |
Login name of the user who originally created the sample record. | |
| CreatorName | String | True |
Display name of the user who originally created the sample record. | |
| PostalCode | String | True |
Postal code associated with the customer or location represented in the sample record. | |
| DepartmentName | String | True |
Name of the department linked to the customer or contact information in the sample record. | |
| EmailAddress | String | True |
Email address of the customer or primary contact stored in the sample record. | |
| PersonInChargeName | String | True |
Name of the staff member responsible for managing the customer or case represented in the sample record. | |
| UpdateDateAndTime | Datetime | True |
Date and time when the sample record was last updated. | |
| CustomerName | String | True |
Name of the customer referenced in the sample record. | |
| Address | String | True |
Physical address associated with the customer or location in the sample record. | |
| TEL | String | True |
Telephone number associated with the customer or primary contact. |
Provides the detail records that belong to the sample Customer Management app so you can explore relational behavior in the Sales Support Pack.
| Name | Type | ReadOnly | References | Description |
| CustomerManagementId | Int | True |
Identifier linking the detail record to its corresponding customer management entry in the sample Sales Support Pack. | |
| Id | Int | True |
Identifier of the detail record within the sample app's table. | |
| Revision | Int | True |
Revision number of the detail record, indicating how many times the entry has been updated. | |
| AppId | Int | True |
Identifier of the sample app that contains this detail table record. | |
| ProjectName | String | True |
Name of the project associated with the customer, as represented in the sample data. | |
| Probability | String | True |
Estimated probability of winning the project, reflecting the sample sales pipeline workflow. | |
| ExpectedOrderDate | Datetime | True |
Expected date when the project may result in an order, based on the sample sales timeline. | |
| TotalCost | Double | True |
Projected total cost or value associated with the project in the sample dataset. | |
| SalesRepresentativeAggregate | String | True |
Aggregate information about the sales representatives assigned to the project within the sample app. |
Indicates whether the membership of the Space is fixed, preventing members from being added or removed outside of administrator settings.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Identifier of the Space, used to reference the workspace throughout the Kintone environment. | |
| Name | String | False |
Display name of the Space as shown in the Kintone interface. | |
| DefaultThread | String | False |
Identifier of the default thread that was automatically created when the Space was first set up. | |
| IsPrivate | Boolean | False |
Indicates whether the Space is private, restricting visibility to explicitly assigned members. | |
| CreatorCode | String | False |
Login name of the user who created the Space, returned as an empty string for inactive or deleted users. | |
| CreatorName | String | False |
Display name of the user who created the Space, returned as an empty string for inactive or deleted users. | |
| ModifierCode | String | False |
Login name of the user who last updated the Space settings, returned as an empty string for inactive or deleted users. | |
| ModifierName | String | False |
Display name of the user who last updated the Space settings, returned as an empty string for inactive or deleted users. | |
| MemberCount | String | False |
Number of members currently belonging to the Space. | |
| CoverType | String | False |
Type of image used for the Space's cover photo, indicating whether it is a preset or an uploaded file. | |
| CoverKey | String | False |
Key identifier of the cover photo assigned to the Space. | |
| CoverUrl | String | False |
URL pointing to the cover photo used in the Space's header. | |
| Body | String | False |
HTML content displayed in the Space body, returned as null when no content is set but may contain preserved tags if content existed previously. | |
| UseMultiThread | Boolean | False |
Indicates whether the Space allows multiple discussion threads instead of using a single-thread structure. | |
| IsGuest | Boolean | False |
Indicates whether the Space is a Guest Space, which restricts access to designated guest users. | |
| AttachedApps | String | False |
List of apps associated with the Space's thread, excluding apps that are not yet published. | |
| ShowAnnouncement | Boolean | False |
Indicates whether the Announcement widget is displayed in the Space. | |
| ShowThreadList | Boolean | False |
Indicates whether the Threads widget is displayed in the Space. | |
| ShowAppList | Boolean | False |
Indicates whether the Apps widget is displayed in the Space. | |
| ShowMemberList | Boolean | False |
Indicates whether the People widget, which shows Space members, is displayed. | |
| ShowRelatedLinkList | Boolean | False |
Indicates whether the Related Apps and Spaces widget is displayed in the Space. |
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 |
| SpaceTemplateID | String |
Identifier of the Space template used when creating a new Space, required during Space creation. |
| Members | String |
List of users assigned to the Space, required when creating a new Space and must include at least one Space Administrator. Inactive or deleted users cannot be included. |
Manages the membership lists of Spaces so you can review or update which users have access to a workspace and its discussions.
The Id column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM SpaceMembers WHERE Id = 1
For updating the SpaceMembers, provide the Members column as an aggregate. The Id column is required to update the SpaceMembers.
UPDATE SpaceMembers SET Members='[{"entity":{"type":"USER","code":"[email protected]"},"isAdmin":true}]' WHERE Id = 1
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Identifier of the Space whose membership details are being retrieved or updated. | |
| EntityCode | String | False |
Code identifying the user, group, or department that is a member of the Space. | |
| EntityType | String | False |
Type of entity assigned to the Space, such as a user, group, or department. | |
| IsAdmin | Boolean | False |
Indicates whether the member has Space Administrator privileges, allowing them to manage Space settings and membership. | |
| IsImplicit | Boolean | False |
Indicates whether the member was added implicitly through group or department membership rather than being added individually. | |
| IncludeSubs | Boolean | False |
Indicates whether membership granted to a department also applies to its subordinate departments. |
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 |
| Members | String |
List of members to assign when creating a new Space, requiring at least one Space Administrator and excluding inactive or deleted users. |
Controls the app views that define filtered, sorted, or custom-formatted record lists, supporting administration of user-facing data presentations.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Views WHERE AppId = 6 SELECT * FROM Views WHERE AppId = 6 AND Lang = 'en' SELECT * FROM Views WHERE AppId = 6 AND IsPreview = false
For updating the Views, provide the Views as an aggregate. View names that are not stated in the aggregate will be deleted. The AppId column is required to update the Views.
UPDATE VIEWS SET Views = '{"(Assigned to me)":{"index":0,"type":"LIST","name":"(Assigned to me)","filterCond":"Assignee in (LOGINUSER())","sort":"Record_number asc"},"subTableTest2":{"index":1,"type":"CALENDAR","name":"subTableTest","date":"Updated_datetime","filterCond":"","sort":"Record_number asc"}}' WHERE AppId = 6
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Identifier of the view, used to reference the specific view configuration within the app. | |
| AppId | Integer | False |
Identifier of the Kintone app that contains the view being retrieved or updated. | |
| Index | String | False |
Ascending display order of the view, determining its position relative to other views in the app. | |
| Name | String | False |
Display name of the view as presented to users in the Kintone interface. | |
| Title | String | False |
Field code used as the title field when displaying calendar views, returned only for calendar-type views. | |
| Type | String | False |
Type of view, such as list, calendar, or custom, defining how records are presented to the user. The allowed values are LIST, CALENDAR, CUSTOM. | |
| BuiltinType | String | False |
Indicates the type of built-in view being used when the view is not custom. | |
| Date | String | False |
Field code used as the date field for calendar views, returned only when the view is configured as a calendar view. | |
| Fields | String | False |
List of field codes that determine which fields appear in the view's record list. | |
| FilterCond | String | False |
Filter condition expressed as a query string, defining which records appear in the view. | |
| Html | String | False |
HTML content used to render a custom view, returned only when the view is defined as a custom layout. | |
| Pager | Boolean | False |
Indicates whether pagination is enabled for the view, returned only for custom views. | |
| Device | String | False |
Specifies the device contexts where the view is displayed, such as desktop or mobile. | |
| Sort | String | False |
Sort order expressed as a query string, defining how records are ordered within the view. | |
| Revision | String | True |
Revision number of the app settings, helping track updates made to the view configuration. |
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 view details in a specific language. |
| IsPreview | Boolean |
Indicates whether to retrieve view details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
| Views | String |
Value used only when performing an update to supply modified view settings. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| ActionSettingsEntities | Returns the detailed components that define each automation rule, helping you understand which fields, conditions, and targets are involved in an action's execution. |
| ActionSettingsMappings | Lists the field-to-field mappings used by automation rules so you can trace exactly how data moves between apps when an action is triggered. |
| Apps | Returns all apps in the Kintone environment with key metadata required for cataloging, governance, or integration with external systems. |
| FieldPermissionsEntities | Breaks field-level permissions into their underlying rules to help you understand exactly how visibility and edit rights differ across users and groups. |
| FormLayoutFields | Returns the individual layout elements used within an app's form, making it easier to analyze field placement, grouping, and user interface design. |
| PerRecordNotificationsTargets | Returns the list of users and groups who receive record-level notifications, supporting communication audits and troubleshooting. |
| ProcessManagementActions | Lists the workflow actions available within a process, helping you analyze or document the transition paths defined in an app's workflow. |
| RecordPermissionsEntities | Breaks record-level permissions into their detailed entities to show how access rules differ for users, groups, and roles. |
| ReminderNotificationsTargets | Returns the users and groups associated with reminder notifications, helping you verify who receives automated follow-up alerts. |
Returns the detailed components that define each automation rule, helping you understand which fields, conditions, and targets are involved in an action's execution.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM ActionSettingsEntities WHERE AppId = 6 SELECT * FROM ActionSettingsEntities WHERE AppId = 6 AND Lang = 'en' SELECT * FROM ActionSettingsEntities WHERE AppId = 6 AND IsPreview = false
| Name | Type | References | Description |
| AppId | Integer | Identifier of the Kintone app whose action-entity assignments are being retrieved. | |
| Id | String | Unique identifier of the action, used to reference or update the specific automation rule. | |
| Code | String | Code of the entity allowed to use the action, with guest users represented by a login name preceded by guest/. | |
| Type | String | Type of entity permitted to use the action, such as a user, group, or department.
The allowed values are USER, GROUP, ORGANIZATION. | |
| Revision | String | Revision number of the app settings, helping track configuration changes over time. |
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-entity details in a specific language. | |
| IsPreview | Boolean | Indicates whether to retrieve action-entity details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
Lists the field-to-field mappings used by automation rules so you can trace exactly how data moves between apps when an action is triggered.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM ActionSettingsMappings WHERE AppId = 6 SELECT * FROM ActionSettingsMappings WHERE AppId = 6 AND Lang = 'en' SELECT * FROM ActionSettingsMappings WHERE AppId = 6 AND IsPreview = false
| Name | Type | References | Description |
| AppId | Integer | Identifier of the Kintone app whose action mapping details are being retrieved. | |
| Id | String | Unique identifier of the action, used to reference or update the specific automation rule. | |
| SrcType | String | Type of source data used by the action's field mapping, indicating whether the action copies from a field or another supported source.
The allowed values are FIELD, RECORD_URL. | |
| SrcField | String | Field code of the source field defined in the field-mapping settings, returned only when the actions.{actionname}.mappings[].srcType value is FIELD. | |
| DestField | String | Field code of the destination field that receives the copied value when the action executes. | |
| Revision | String | Revision number of the app settings, helping track configuration changes to mapping definitions. |
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 mapping details in a specific language. | |
| IsPreview | Boolean | Indicates whether to retrieve mapping details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
Returns all apps in the Kintone environment with key metadata required for cataloging, governance, or integration with external systems.
By default, the Sync App will use the Kintone APIs to process search criteria that refer to the following columns and will process other filters client-side within the Sync App: the Kintone API supports searches on the AppId, Code, and SpaceId columns. These columns support server-side processing for the = and IN operators while the Name column supports only the LIKE operator. For example, the following query is processed server side:
SELECT * FROM Apps WHERE AppId IN (20, 21, 51, 56) AND Name LIKE '%To Do%'
| Name | Type | References | Description |
| AppId [KEY] | Integer | Identifier of the Kintone app whose details are being retrieved. | |
| Code | String | App code assigned to the app, returned as a blank value when no app code is configured in the app settings. | |
| Name | String | Display name of the app, returned in the user's configured language when localization settings are enabled. | |
| Description | Longvarchar | Text description of the app, returned in the user's configured language when localization settings are enabled. | |
| SpaceId | String | Identifier of the space that contains the app, with the value of 'null' returned when the app is not created inside a space. | |
| ThreadId | String | Identifier of the thread that contains the app when the app is created inside a space, with the value of 'null' returned when the app does not belong to a space or thread. | |
| CreatedAt | Datetime | Date and time when the app was created. | |
| CreatorCode | String | Login name of the user who created the app, with no value returned for inactive or deleted users. | |
| CreatorName | String | Display name of the user who created the app, with no value returned for inactive or deleted users. | |
| ModifiedAt | Datetime | Date and time when the app was last modified. | |
| ModifierCode | String | Login name of the user who last updated the app, with no value returned for inactive or deleted users. | |
| ModifierName | String | Display name of the user who last updated the app, with no value returned for inactive or deleted users. | |
| Alias | String | Alias name defined for the app, which can be made unique by using the connection property TableNameMode=AppId. | |
| ItemUrl | String | Unique URL used to access or reference the app within the Kintone environment. |
Breaks field-level permissions into their underlying rules to help you understand exactly how visibility and edit rights differ across users and groups.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM FieldPermissionsEntities WHERE AppId = 6 SELECT * FROM FieldPermissionsEntities WHERE AppId = 6 AND IsPreview = false
| Name | Type | References | Description |
| AppId [KEY] | Integer | Identifier of the Kintone app whose field-permission assignments are being examined or updated. | |
| Code [KEY] | String | Field code that identifies the specific app field for which detailed entity-level permissions are defined. | |
| EntityType | String | Type of entity receiving the field permission, such as a user, group, or department, allowing you to understand how access is structured across the organization. | |
| EntityCode | String | Code that uniquely identifies the user, group, or department to which the field permission applies. | |
| Accessibility | String | Permission level granted to the entity, indicating whether the entity can view, edit, or is restricted from interacting with the field.
The allowed values are READ, WRITE, NONE. | |
| IncludeSubs | Boolean | Indicates whether field permissions granted to a department should also apply to its subordinate departments, supporting hierarchical access control. |
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 | |
| IsPreview | Boolean | Indicates whether to retrieve field-permission details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
Returns the individual layout elements used within an app's form, making it easier to analyze field placement, grouping, and user interface design.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM FormLayoutFields WHERE AppId = 6 SELECT * FROM FormLayoutFields WHERE AppId = 6 AND Lang = 'en' SELECT * FROM FormLayoutFields WHERE AppId = 6 AND IsPreview = false
| Name | Type | References | Description |
| AppId | Integer | Identifier of the Kintone app whose form-layout field details are being retrieved. | |
| Code | String | Field code that uniquely identifies the field placed within the form layout. | |
| Type | String | Type of field represented in the layout, determining how the element behaves and is rendered in the form. | |
| ElementId | String | Element identifier assigned to a Space field, returned only when the layout element is a Space field. | |
| Label | Longvarchar | Text used as the label for a Label field, returned only when the element represents a Label component. | |
| Width | String | Width of the field in pixels, defining how much horizontal space the element occupies in the layout. | |
| Height | String | Total height of the field in pixels, including the space used by the field name. | |
| InnerHeight | String | Height of the field in pixels excluding the field name, showing the actual input or display area size. |
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 | |
| IsPreview | Boolean | Indicates whether to retrieve form-layout field details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
Returns the list of users and groups who receive record-level notifications, supporting communication audits and troubleshooting.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM PerRecordNotificationsTargets WHERE AppId = 6 SELECT * FROM PerRecordNotificationsTargets WHERE AppId = 6 AND Lang = 'en' SELECT * FROM PerRecordNotificationsTargets WHERE AppId = 6 AND IsPreview = false
| Name | Type | References | Description |
| AppId | Integer | Identifier of the Kintone app whose per-record notification target settings are being retrieved. | |
| Title | String | Subject line of the per-record notification, matching the Summary text used when the notification is sent. | |
| EntityType | String | Type of entity configured to receive the per-record notification, such as a user, group, or department. | |
| EntityCode | String | Code identifying the specific entity that receives the per-record notification. | |
| IncludeSubs | Boolean | Indicates whether notification rules assigned to a department should also apply to its subordinate departments. |
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 target-setting values in a specific language. | |
| IsPreview | Boolean | Indicates whether to retrieve per-record notification target details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
Lists the workflow actions available within a process, helping you analyze or document the transition paths defined in an app's workflow.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM ProcessManagementActions WHERE AppId = 6 SELECT * FROM ProcessManagementActions WHERE AppId = 6 AND Lang = 'en' SELECT * FROM ProcessManagementActions WHERE AppId = 6 AND IsPreview = false
| Name | Type | References | Description |
| AppId | Integer | Identifier of the Kintone app whose process-management action settings are being retrieved. | |
| Name | String | Name of the workflow action, representing the transition users can apply to move a record between statuses. | |
| From | String | Name of the current workflow status from which the action can be performed. | |
| To | String | Name of the workflow status that the record is moved to when the action is executed. | |
| FilterCond | String | Condition expressed in query-string format that determines whether the action is available based on record data. |
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 process-management action details in a specific language. | |
| IsPreview | Boolean | Indicates whether to retrieve process-management action details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
Breaks record-level permissions into their detailed entities to show how access rules differ for users, groups, and roles.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM RecordPermissionsEntities WHERE AppId = 6 SELECT * FROM RecordPermissionsEntities WHERE AppId = 6 AND Lang = 'en' SELECT * FROM RecordPermissionsEntities WHERE AppId = 6 AND IsPreview = false
| Name | Type | References | Description |
| AppId | Integer | Identifier of the Kintone app whose record-permission entity assignments are being retrieved. | |
| FilterCond | String | Filter condition expressed in query-string format that specifies which records the entity-level permissions apply to. | |
| EntityType | String | Type of entity that receives the record-level permission, such as a user, group, or department. | |
| EntityCode | String | Code identifying the specific entity to which the record-level permission is granted. | |
| Viewable | Boolean | Indicates whether the entity has permission to view records that match the filter condition. | |
| Editable | Boolean | Indicates whether the entity has permission to edit records that match the filter condition. | |
| Deletable | Boolean | Indicates whether the entity has permission to delete records that match the filter condition. | |
| IncludeSubs | Boolean | Indicates whether permissions assigned to a department should also apply to its subordinate departments. |
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 entity-level record-permission details in a specific language. | |
| IsPreview | Boolean | Indicates whether to retrieve record-permission entity details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
Returns the users and groups associated with reminder notifications, helping you verify who receives automated follow-up alerts.
The AppId column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM ReminderNotificationsTargets WHERE AppId = 6 SELECT * FROM ReminderNotificationsTargets WHERE AppId = 6 AND Lang = 'en' SELECT * FROM ReminderNotificationsTargets WHERE AppId = 6 AND IsPreview = false
| Name | Type | References | Description |
| AppId [KEY] | Integer | Identifier of the Kintone app whose reminder-notification target settings are being retrieved. | |
| TimingCode [KEY] | String | Field code of the date or datetime field that determines when the reminder notification is triggered. | |
| EntityType | String | Type of entity configured to receive the reminder notification, such as a user, group, or department. | |
| EntityCode | String | Code identifying the specific entity that receives the reminder notification. | |
| IncludeSubs | Boolean | Indicates whether reminder-notification rules assigned to a department should also apply to its subordinate departments. |
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 reminder-notification target details in a specific language. | |
| IsPreview | Boolean | Indicates whether to retrieve reminder-notification target details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Kintone.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Kintone, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| AddGuests | Adds guest users to the Kintone environment for controlled external access without sending invitations or automatically assigning them to Spaces. |
| AddGuestsToSpace | Assigns existing guest users to a specific guest Space so administrators can grant workspace-level access where needed. |
| AddThreadComment | Adds a comment to a discussion thread inside a Space to support team communication and auditability. |
| AppsDeployStatus | Returns the deployment status for one or more apps so you can track whether recent app updates are live and available to users. |
| CreateApp | Creates a new Kintone app from a provided configuration, supporting automated provisioning workflows. |
| DeleteGuests | Removes a guest user from the environment, helping administrators maintain security and revoke external access when needed. |
| DeployApps | Deploys pending app updates so schema changes, permissions, and settings become active in the production environment. |
| UpdateAssignees | Updates the user or group assigned to a record, supporting workflow progression or ownership changes. |
| UpdateStatus | Updates a record's status field to move it through a workflow step or process stage. |
| UpdateThread | Updates an existing discussion thread inside a Space so teams can maintain current and accurate collaboration history. |
Adds guest users to the Kintone environment for controlled external access without sending invitations or automatically assigning them to Spaces.
Kintone allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison.
For example:
Insert into GuestsAggregate#TEMP(Name, Code, Password, Timezone) Values('Jack', '[email protected]', '#jack@123', 'America/Los_Angeles')
Insert into GuestsAggregate#TEMP(Name, Code, Password, Timezone) Values('Geeky', '[email protected]', '#geeky@321', 'America/Los_Angeles')
EXECUTE AddGuests GuestsAggregate = 'GuestsAggregate#TEMP'
The second way of using the Stored Procedure is by adding the aggregate itself:
EXECUTE AddGuests GuestsAggregate = '[{"code":"[email protected]","password":"#abcd@123","timezone":"America/Los_Angeles","locale":"en","name":"John Doe","company":"Company Name","division":"Sales","callto":"skypecallto"}]'
| Name | Type | Required | Description |
| Name | String | False | Display name assigned to the guest user, which must contain between 1 and 128 characters. |
| Code | String | False | Email address used as the guest user's login name, serving as the primary identifier for authentication. |
| Password | String | False | Alphanumeric password for the guest user's login credentials, required for account creation. |
| Timezone | String | False | Time zone setting applied to the guest user, used for timestamp display and scheduling behavior. |
| Locale | String | False | Specifies the language preference for the guest user. Accepted values are 'auto', 'en', 'zh', 'ja'. The default value is 'auto'. |
| Image | String | False | Profile image for the guest user, provided by specifying the fileKey of an uploaded file. |
| SurNameReading | String | False | Phonetic reading of the guest user's surname, with a maximum length of 64 characters. |
| GivenNameReading | String | False | Phonetic reading of the guest user's given name, with a maximum length of 64 characters. |
| Company | String | False | Company name displayed on the guest user's profile to provide organizational context. |
| Division | String | False | Department or division name displayed on the guest user's profile. |
| Phone | String | False | Contact phone number displayed on the guest user's profile. |
| CallTo | String | False | Skype name associated with the guest user for communication or collaboration purposes. |
| GuestsAggregate | String | False | Aggregate structure containing one or more guest user definitions for batch processing. |
| Name | Type | Description |
| Success | String | Indicates whether the operation completed successfully by returning a Boolean value. |
Assigns existing guest users to a specific guest Space so administrators can grant workspace-level access where needed.
Kintone allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison.
For example:
EXECUTE AddGuestsToSpace GuestSpaceId = '6', Guests = '["[email protected]","[email protected]","[email protected]"]'
| Name | Type | Required | Description |
| GuestSpaceId | String | True | Identifier of the guest space to which the specified guest users are added. |
| Guests | String | True | List of email addresses representing the guest users who should be granted access to the guest space. |
| Name | Type | Description |
| Success | String | Indicates whether the operation completed successfully by returning a Boolean value. |
Adds a comment to a discussion thread inside a Space to support team communication and auditability.
Kintone allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison.
For example:
EXECUTE AddThreadComment SpaceId = 8, ThreadId = 8, Text = 'Test Comment'
| Name | Type | Required | Description |
| SpaceId | Integer | True | Identifier of the space where the comment is added. |
| ThreadId | Integer | True | Identifier of the thread within the space that receives the new comment. |
| Text | String | False | Content of the comment, supporting line breaks using LF and allowing up to 65,535 characters. This value is required if the Files input is not provided. |
| Mentions | String | False | Array of mention objects used to notify other Kintone users within the comment. |
| Files | String | False | Array containing attachment file data, allowing up to five files. This value is required if the Text input is not provided. |
| Name | Type | Description |
| Id | String | Identifier of the newly created comment. |
| Success | String | Indicates whether the operation completed successfully by returning a Boolean value. |
Returns the deployment status for one or more apps so you can track whether recent app updates are live and available to users.
| Name | Type | Required | Description |
| AppIds | String | True | Specifies one or more app IDs to check, allowing a single value or a comma-separated list of IDs. |
| GuestSpaceId | String | False | Identifies the guest space that contains the apps, and should be omitted when the connection property GuestSpaceId is already set in the connection string. |
| Name | Type | Description |
| AppId | String | Returns the ID of the app whose deployment status is being reported. |
| Status | String | Returns the deployment status of the app, indicating whether recent updates have been applied. |
Creates a new Kintone app from a provided configuration, supporting automated provisioning workflows.
| Name | Type | Required | Description |
| Name | String | True | Specifies the name of the new app, which must contain fewer than 64 characters to meet Kintone's naming requirements. |
| Space | String | False | The Id of the space. Do not specify this if the connection property GuestSpaceId is set in the connection string. |
| ThreadId | String | False | The Id of the thread. This is required if the Space parameter or the connection property GuestSpaceId is specified. |
| IsGuestSpace | Boolean | False | Indicates whether the Space parameter refers to a guest space, requiring the value 'true' for guest spaces and 'false' for normal spaces.
The default value is false. |
| Name | Type | Description |
| AppId | String | Returns the identifier of the newly created app. |
| Revision | String | Returns the revision number assigned to the new app's initial configuration. |
| Success | String | Indicates whether the operation completed successfully by returning a Boolean value. |
Removes a guest user from the environment, helping administrators maintain security and revoke external access when needed.
Kintone allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:
For Deleting the Guests, provide the comma separated values of Guests.
EXECUTE DeleteGuests Guests = '["[email protected]","[email protected]"]'
| Name | Type | Required | Description |
| Guests | String | True | List of email addresses identifying the guest users to delete, allowing up to 100 users to be removed in a single operation. |
| Name | Type | Description |
| Success | String | Indicates whether the operation completed successfully by returning a Boolean value. |
Deploys pending app updates so schema changes, permissions, and settings become active in the production environment.
Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.
Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:
EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
In the Input table below, indexed parameters are denoted with a '#' character at the end of their names.
| Name | Type | Required | Description |
| AppId# | String | True | Specifies one or more app IDs to deploy, allowing a single value or a comma-separated list of IDs. |
| Revision# | String | False | Specifies the revision number to deploy. The request fails if the provided revision does not match the latest operational configuration. |
| Revert | Boolean | False | Indicates whether to cancel pending application-setting changes by setting this value to 'true'.
The default value is false. |
| GuestSpaceId | String | False | Identifies the guest space that contains the apps, and should not be provided when the connection property GuestSpaceId is already set in the connection string. |
| Name | Type | Description |
| Success | String | Indicates whether the operation completed successfully by returning a Boolean value. |
Downloads a file stored in an app's attachment field so it can be archived, processed externally, or analyzed offline.
| Name | Type | Required | Description |
| FileKey | String | True | Identifier of the file to download, used to retrieve the correct file from the app's attachment data. |
| LocalPath | String | False | Local file-system path where the downloaded file is saved when writing directly to disk. |
| FileName | String | False | File name to use when saving the downloaded content, allowing you to control the output file's naming. |
| GuestSpaceId | String | False | Guest space containing the file. Should not be provided when the connection property GuestSpaceId is already set in the connection string. |
| Encoding | String | False | Encoding type applied to the FileData output when the file content is returned directly.
The allowed values are NONE, BASE64. The default value is BASE64. |
| Name | Type | Description |
| FileData | String | Raw file data returned when neither LocalPath nor FileStream input is supplied, enabling in-memory processing of the downloaded content. |
| Success | String | Indicates whether the operation completed successfully by returning a Boolean value. |
Gets an authentication token from Kintone.
| Name | Type | Required | Description |
| AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
The allowed values are APP, WEB. The default value is APP. |
| CallbackUrl | String | False | The URL the user is redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Kintone app settings. Only needed when the Authmode parameter is Web. |
| Verifier | String | False | The verifier returned from Kintone after the user has authorized your app to have access to their data. This value is returned as a parameter to the callback URL. |
| Scope | String | False | A space separated list of scopes limiting an application's access to a user's account.
The default value is k:app_record:read k:app_record:write k:app_settings:read k:app_settings:write k:file:read k:file:write. |
| State | String | False | Encoded state of the app, which is returned verbatim in the response and can be used to match the response up to a given request. |
| Name | Type | Description |
| OAuthAccessToken | String | The access token used for communication with Kintone. |
| OAuthRefreshToken | String | The OAuth refresh token. This is the same as the access token in the case of Kintone. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it does not expire. |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You request the OAuthAccessToken from this URL.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The URL the user is redirected to after authorizing your application. This value must match the Redirect URL in the Kintone app settings. |
| State | String | False | Encoded state of the app, which is returned verbatim in the response and can be used to match the response up to a given request. |
| Scope | String | False | A space separated list of scopes limiting an application's access to a user's account.
The default value is k:app_record:read k:app_record:write k:app_settings:read k:app_settings:write k:file:read k:file:write. |
| Name | Type | Description |
| URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
Refreshes the OAuth access token used for authentication with Kintone.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | Set this to the token value that expired. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from Kintone. This can be used in subsequent calls to other operations for this particular service. |
| OAuthRefreshToken | String | This is the same as the access token. |
| ExpiresIn | String | The remaining lifetime on the access token. |
Updates the user or group assigned to a record, supporting workflow progression or ownership changes.
| Name | Type | Required | Description |
| AppId | String | True | Identifier of the Kintone app that contains the record whose assignees are updated. |
| RecordId | String | True | Identifier of the record for which the assignees are being changed. |
| Assignees | String | True | List of user codes representing the users assigned to the record, allowing up to 100 assignees and assigning none when the list is empty. |
| Revision | String | False | Revision number of the record before the update, required to prevent conflicts when the record has been modified since it was last retrieved. |
| GuestSpaceId | String | False | Identifies the guest space that contains the record, and should not be provided when the connection property GuestSpaceId is already set in the connection string. |
| Name | Type | Description |
| Success | String | Indicates whether the operation completed successfully by returning a Boolean value. |
| Revision | String | Revision number of the record after the update, which increases by two because both running the action and updating the status count as separate operations. |
Updates a record's status field to move it through a workflow step or process stage.
Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.
Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:
EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
In the Input table below, indexed parameters are denoted with a '#' character at the end of their names.
| Name | Type | Required | Description |
| AppId | String | True | Identifier of the Kintone app that contains the record whose status is updated. |
| RecordId# | String | True | Identifier of the record that is moved to a new status when the action is executed. |
| Action# | String | True | Name of the workflow action to run, which must match the action name in the user's language settings when localized action names are in use. |
| Assignee# | String | False | Login name of the user who becomes the next assignee after the status transition is completed. |
| Revision# | String | False | Revision number of the record before the status update, required to ensure the record has not been modified since it was last retrieved. |
| GuestSpaceId | String | False | Identifies the guest space that contains the record, and should not be provided when the connection property GuestSpaceId is already set in the connection string. |
| Name | Type | Description |
| Success | String | Indicates whether the operation completed successfully by returning a Boolean value. |
| Id | String | Identifier of the record whose status was updated. |
| Revision | String | Revision number of the record after the update, which increases by two because both running the action and updating the status count as separate operations. |
Updates an existing discussion thread inside a Space so teams can maintain current and accurate collaboration history.
Kintone allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison.
For example:
EXECUTE UpdateThread ThreadId = 13, Name = 'Test Thread', Body = 'This is for testing'
| Name | Type | Required | Description |
| ThreadId | Integer | True | Identifier of the thread to update, which can be obtained from the thread's URL. |
| Name | String | False | New display name for the thread, replacing the old name if set. It must have between 1 and 128 characters and cannot be used for Spaces that support only a single thread. |
| Body | String | False | Updated HTML or text content for the thread body, replacing the existing thread description or discussion header. |
| Name | Type | Description |
| Success | String | Indicates whether the operation completed successfully by returning a Boolean value. |
Uploads a file to Kintone for use as an attachment or app resource during record creation or updates.
| Name | Type | Required | Description |
| FullPath | String | False | Full local path of the file to upload, required when the FileData input is not provided. |
| FileData | String | False | Base64-encoded representation of the file content, used when the FullPath input is not supplied. |
| FileName | String | False | Name to assign to the uploaded file, required when providing the Content or FileData input and optional when FullPath is used. |
| GuestSpaceId | String | False | Identifies the guest space containing the file, and should not be provided when the connection property GuestSpaceId is already set in the connection string. |
| AttachToApp | String | False | Indicates whether the uploaded file should be attached to an app's attachment field. Accepted values are 'true' or 'false'. The default value is 'false'. |
| UploadedFileKey | String | False | Identifier of an already uploaded file, required when the AttachToApp parameter is set to 'true' and no Content, FileData, or FullPath value is provided. |
| AppId | String | False | Identifier of the Kintone app the file is attached to, required when AttachToApp is set to 'true'. |
| Name | Type | Description |
| FileKey | String | Identifier assigned to the uploaded file, used for attaching or retrieving the file later. |
| Success | String | Indicates whether the operation completed successfully by returning a Boolean value. |
| Id | String | Record identifier created when the file is attached to an app, returned only when the request includes an attach parameter. |
| Revision | String | Revision number of the record after the file attachment operation. It increases by two because running the action and updating the status count as separate operations. It is returned only when the request includes an attach parameter. |
The Sync App models the Kintone USER API as relational Views.
The Sync App models User, UserGroups and UserDepartments information in view.
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| UserDepartments | Returns the departments a user belongs to along with related job title information, supporting organizational mapping and identity management. |
| UserGroups | Returns the groups associated with a user so you can understand their access rights and collaborative relationships across the system. |
| Users | Returns detailed user profile information from the Cybozu directory to support identity synchronization and permission audits. |
Returns the departments a user belongs to along with related job title information, supporting organizational mapping and identity management.
The UserCode column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM UserDepartments where UserCode = 'loginname';
| Name | Type | References | Description |
| OrganizationId [KEY] | Long | Unique identifier for the department, used to link department records to related organizational data. | |
| TitleId [KEY] | Long | Unique identifier for the job title, allowing you to associate users or roles with a specific title. | |
| OrganizationCode | String | Code assigned to the department, typically used for internal categorization or external system references. | |
| OrganizationName | String | Primary display name of the department as it appears in the organization's directory. | |
| OrganizationLocalName | String | Localized display name of the department for regions or languages that require a translated label. | |
| OrganizationLocalNameLocale | String | Locale code indicating the language or region associated with the department's localized name. | |
| OrganizationParentCode | String | Code of the department's parent unit to help model the organizational hierarchy. If the value is 'null', it indicates a root-level department. | |
| OrganizationDescription | Longvarchar | Text description that provides additional context about the department's responsibilities or purpose. | |
| TitleCode | String | Internal or external reference code assigned to the job title for classification or system integration. | |
| TitleName | String | Human-readable name of the job title used in employee profiles and organizational charts. | |
| TitleDescription | Longvarchar | Text description explaining the scope, responsibilities, or role of the job title. |
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 | |
| UserCode | String | Login name associated with the user, used to identify the user when querying related records. |
Returns the groups associated with a user so you can understand their access rights and collaborative relationships across the system.
The UserCode column is required in the WHERE clause. The Sync App will use the Kintone APIs to filter the results by this column. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM UserGroups where UserCode = 'loginname';
| Name | Type | References | Description |
| GroupId [KEY] | Long | Unique identifier for the group, used to link the group to membership records and permission assignments. | |
| GroupCode | String | Internal reference code assigned to the group for classification or integration with external systems. | |
| GroupName | String | Display name of the group as it appears in user directories and access management tools. | |
| GroupDescription | Longvarchar | Text description that outlines the purpose, role, or membership characteristics of the group. |
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 | |
| UserCode | String | Login name associated with the user, used to identify which user belongs to the group when querying relationships. |
Returns detailed user profile information from the Cybozu directory to support identity synchronization and permission audits.
The Sync App uses the Kintone API to process supported filters. By default, the Sync App will process other filters client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Users where id = 1;
SELECT * FROM Users where id in (1,2);
SELECT * FROM Users where Code = 'loginname';
SELECT * FROM Users where code in ('loginname1','loginname2');
| Name | Type | References | Description |
| Id [KEY] | Long | Unique identifier for the user, used to reference the user across related records and organizational structures. | |
| Code | String | Login name associated with the user, used for authentication and identifying the user in queries. | |
| CreatedTime | Datetime | Date and time when the user account was first created, supporting audit and lifecycle tracking. | |
| UpdatedTime | Datetime | Date and time when the user account was last modified, helping track profile updates or administrative changes. | |
| Valid | Boolean | Indicates whether the user's status is active, allowing systems to filter out deactivated or archived accounts. | |
| Name | String | Primary display name of the user as it appears in directories and user-facing applications. | |
| SurName | String | Family name of the user, typically used in formal identification and directory listings. | |
| GivenName | String | First name of the user, representing the personal portion of the user's full name. | |
| SurNameReading | String | Phonetic reading of the user's family name, supporting pronunciation guidance in languages that require it. | |
| GivenNameReading | String | Phonetic reading of the user's first name, helping ensure accurate pronunciation in supported locales. | |
| LocalName | String | Localized version of the user's display name for regions or languages that require translation or adaptation. | |
| LocalNameLocale | String | Locale code indicating the language or region associated with the user's localized display name. | |
| Timezone | String | Identifier of the time zone configured for the user, ensuring correct scheduling and timestamp alignment. | |
| Locale | String | Language preference set for the user, influencing UI display and formatting behavior. | |
| Description | Longvarchar | The user's profile description or About Me text, often used to share background information or role context. | |
| Phone | String | Primary phone number associated with the user for contact or directory purposes. | |
| MobilePhone | String | Mobile phone number of the user, used for direct communication or multi-factor verification. | |
| ExtensionNumber | String | Internal extension assigned to the user for office or system-based telecommunications. | |
| String | Email address of the user, serving as a primary communication channel and identifier. | ||
| SkypeID | String | Skype identifier associated with the user for messaging or online collaboration. | |
| Url | String | Profile URL field where the user can include a personal or work-related link. | |
| EmployeeNumber | String | Employee number assigned to the user for internal tracking, payroll, or Human Resources (HR) systems. | |
| BirthDate | Datetime | Birth date of the user, used for administrative records or compliance requirements. | |
| JoinDate | Datetime | Hire date of the user, supporting tenure tracking, HR records, and onboarding workflows. | |
| PrimaryOrganization | Integer | Identifier of the user's primary department. If the value is 'null', there is no designated primary assignment. | |
| SortOrder | Integer | Display order value used to control how the user appears in sorted lists or organizational views. | |
| CustomItemValues | String | List of custom field name and code pairs, representing extended profile attributes defined by the organization. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | Whether to connect to Kintone with User/Password or APIToken or OAuth. |
| URL | The Kintone URL. For example: https://SUBDOMAIN_NAME.cybozu.com . |
| Schema | Specify the Kintone API version to use. |
| User | Specifies the authenticating user's user ID. |
| Password | Specifies the authenticating user's password. |
| BasicAuthUser | The additional username required for domains using basic authentication. |
| BasicAuthPassword | The additional password required for domains using basic authentication. |
| AppId | The AppId used along with the APIToken for authentication. |
| APIToken | The APIToken used for authentication. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
| Property | Description |
| SSLClientCert | Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection. |
| SSLClientCertType | Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source. |
| SSLClientCertPassword | Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access. |
| SSLClientCertSubject | Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| AllowSpecialCharacters | Determines whether or not to allow special characters. If true special characters will not be replaced. |
| CheckForSubtablesIn | A comma-separated list of Kintone apps to retrieve subtables from. |
| GuestSpaceId | Restrict query results to a guest space. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| NumberMapToDouble | Determines whether or not to change the datatype of number fields from decimal to double. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Kintone. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| SubtableIdAsLong | Specifies whether the Id column in subtables should use the Long data type. |
| SubtableSeparatorCharacter | The character used for dividing tables from subtables in the format tablename + char + subtable. |
| TableNameMode | The dynamic table identifier for each AppId. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UseCodeForFieldName | Determines whether to use Label or Code for Field Name. |
| UseCursor | Boolean determining if cursors should be used to retrieve records. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UseSimpleNames | Specifies whether or not simple names should be used for tables and columns. |
| UseUnitForNumericField | Determines whether to display unit with Field Name. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AuthScheme | Whether to connect to Kintone with User/Password or APIToken or OAuth. |
| URL | The Kintone URL. For example: https://SUBDOMAIN_NAME.cybozu.com . |
| Schema | Specify the Kintone API version to use. |
| User | Specifies the authenticating user's user ID. |
| Password | Specifies the authenticating user's password. |
| BasicAuthUser | The additional username required for domains using basic authentication. |
| BasicAuthPassword | The additional password required for domains using basic authentication. |
| AppId | The AppId used along with the APIToken for authentication. |
| APIToken | The APIToken used for authentication. |
Whether to connect to Kintone with User/Password or APIToken or OAuth.
The Kintone URL. For example: https://SUBDOMAIN_NAME.cybozu.com .
The Kintone URL. For example:
https://SUBDOMAIN_NAME.cybozu.com
Specify the Kintone API version to use.
Select from the following to specify which API version of Kintone to use:
Specifies the authenticating user's user ID.
The authenticating server requires both User and Password to validate the user's identity.
Specifies the authenticating user's password.
The authenticating server requires both User and Password to validate the user's identity.
The additional username required for domains using basic authentication.
The basic authentication username, used to connect to basic-authentication-enabled domains. Basic authentication provides a double authentication: if you are connecting to a domain using basic authentication, set BasicAuthUser and BasicAuthPassword in addition to User and Password.
The additional password required for domains using basic authentication.
The basic authentication password, used to connect to basic-authentication-enabled domains. Basic authentication provides a double authentication: if you are connecting to a domain using basic authentication, set BasicAuthUser and BasicAuthPassword in addition to User and Password.
The AppId used along with the APIToken for authentication.
The AppId is the number of that specific app in the sequence under Apps in Kintone UI dashboard.
You can also specify multiple comma-seperated AppIds.
The APIToken used for authentication.
The APIToken used for authentication.To create an API token. Access the specific app to create the API tokens for and click on the cog wheel. Proceed to App Settings tab > API Token > click on the Generate button, an API token will be generated.
You can also specify multiple comma-seperated APITokens in case of operations involving Lookup fields or Related Record fields.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.
When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.
When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLClientCert | Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection. |
| SSLClientCertType | Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source. |
| SSLClientCertPassword | Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access. |
| SSLClientCertSubject | Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store. |
Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.
This property specifies the client certificate store for SSL Client Authentication. Use this property alongside SSLClientCertType, which defines the type of the certificate store, and SSLClientCertPassword, which specifies the password for password-protected stores. When SSLClientCert is set and SSLClientCertSubject is configured, the driver searches for a certificate matching the specified subject.
Certificate store designations vary by platform. On Windows, certificate stores are identified by names such as MY (personal certificates), while in Java, the certificate store is typically a file containing certificates and optional private keys.
The following are designations of the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
| SPC | Software publisher certificates. |
For PFXFile types, set this property to the filename. For PFXBlob types, set this property to the binary contents of the file in PKCS12 format.
Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source.
This property determines the format and location of the key store used to provide the client certificate. Supported values include platform-specific and universal key store formats. The available values and their usage are:
| USER - default | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java. |
| MACHINE | For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java. |
| PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
| JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java. |
| JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java. |
| PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
| PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
| SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
| P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
| PPKFILE | The certificate store is the name of a file that contains a PuTTY Private Key (PPK). |
| XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
| XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
| BCFKSFILE | The certificate store is the name of a file that contains an Bouncy Castle keystore. |
| BCFKSBLOB | The certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore. |
Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.
This property provides the password needed to open a password-protected certificate store. This property is necessary when using certificate stores that require a password for decryption, as is often recommended for PFX or JKS type stores.
If the certificate store type does not require a password, for example USER or MACHINE on Windows, this property can be left blank. Ensure that the password matches the one associated with the specified certificate store to avoid authentication errors.
Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store.
This property determines which client certificate to load based on its subject. The Sync App searches for a certificate that exactly matches the specified subject. If no exact match is found, the Sync App looks for certificates containing the value of the subject. If no match is found, no certificate is selected.
The subject should follow the standard format of a comma-separated list of distinguished name fields and values. For example, CN=www.server.com, OU=Test, C=US. Common fields include the following:
| Field | Meaning |
| CN | Common Name. This is commonly a host name like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
Note: If any field contains special characters, such as commas, the value must be quoted. For example: CN="Example, Inc.", C=US.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Kintone. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Kintone. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to Kintone. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
Supported authentication types :
For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The username of a user registered with the proxy server. |
| DIGEST | The username of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\\CData\\Kintone Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| AllowSpecialCharacters | Determines whether or not to allow special characters. If true special characters will not be replaced. |
| CheckForSubtablesIn | A comma-separated list of Kintone apps to retrieve subtables from. |
| GuestSpaceId | Restrict query results to a guest space. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| NumberMapToDouble | Determines whether or not to change the datatype of number fields from decimal to double. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Kintone. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| SubtableIdAsLong | Specifies whether the Id column in subtables should use the Long data type. |
| SubtableSeparatorCharacter | The character used for dividing tables from subtables in the format tablename + char + subtable. |
| TableNameMode | The dynamic table identifier for each AppId. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UseCodeForFieldName | Determines whether to use Label or Code for Field Name. |
| UseCursor | Boolean determining if cursors should be used to retrieve records. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UseSimpleNames | Specifies whether or not simple names should be used for tables and columns. |
| UseUnitForNumericField | Determines whether to display unit with Field Name. |
Determines whether or not to allow special characters. If true special characters will not be replaced.
Determines whether or not to allow special characters. If true special characters will not be replaced.
A comma-separated list of Kintone apps to retrieve subtables from.
Set this field to * to check for subtables in all Kintone apps. Set this field to 'None' to not search for any subtables. Kintone subtables are exposed as separate tables and retrieving the list of all subtables from the API is a time-consuming operation. By specifying only some app names in this field, the performance of the Sync App increases. You can also set this field to * to check for subtables in all Kintone apps, but note that if there is a large number of apps, listing the tables will take much longer.
Restrict query results to a guest space.
This connection property restricts query results to the specified guest space.
You can find the GuestSpaceId from the Sync App in the SpaceId column of the Apps table. Or, obtain the GuestSpaceId from the URL when you navigate to the created space. For example, in the following URL, the GuestSpaceId would be "3":
https://xlqc1.cybozu.com/k/guest/3/#/space/3/thread/3
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Determines whether or not to change the datatype of number fields from decimal to double.
Determines whether or not to change the datatype of number fields from decimal to double. If true the datatype will be changed from decimal to double.
Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.
| Property | Description |
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the maximum number of records per page the provider returns when requesting data from Kintone.
When processing a query, instead of requesting all of the queried data at once from Kintone, the Sync App can request the queried data in pieces called pages.
This connection property determines the maximum number of results that the Sync App requests per page.
Note: Setting large page sizes may improve overall query execution time, but doing so causes the Sync App to use more memory when executing queries and risks triggering a timeout.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Specifies whether the Id column in subtables should use the Long data type.
By default, the Id column in subtables is returned as an Integer. Setting SubtableIdAsLong to true changes the type of this column to Long.
This property is useful if your subtables contain a large number of records, where the Integer type might be insufficient to represent all values reliably.
The character used for dividing tables from subtables in the format tablename + char + subtable.
If an app has a subtable, it is represented as a separate table. Its name will be the AppName + SubtableSeparatorCharacter + SubtableName. Use this property to set a custom character as the separator and easily identify subtables from apps. This property allows you to set different special characters in the subtable's name without breaking your app's naming conventions.
The dynamic table identifier for each AppId.
The dynamic table identifier for each AppId can be either the AppName or the AppId to uniquely identify the table. By default, the identifier will be the AppName.
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Determines whether to use Label or Code for Field Name.
If true, Code is used for Field Name.
Boolean determining if cursors should be used to retrieve records.
Boolean determining if cursors should be used to retrieve records.
Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Comments WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
Specifies whether or not simple names should be used for tables and columns.
Kintone tables can include special characters in their names that are typically not allowed in standard databases. This property makes the Sync App easier to use with traditional database tools.
Setting UseSimpleNames to True simplifies the names of the columns that are returned. It enforces a naming scheme where only alphanumeric characters and underscores are valid for displayed column names.
Notes:
Determines whether to display unit with Field Name.
If set to false, Unit will not be displayed with Field Name.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.