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 "REST" for connecting to Kintone REST API.
Kintone REST API supports following authentication schemes:
Set Schema to "USER" 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 REST Data Model for the available entities in the REST Data Model.
See USER Data Model for the available entities in the USER 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 | Update and Query the available Action Settings in kintone. |
| AppPermissions | Update and Query the App Permissions in kintone. |
| Comments | Query the available comments in kintone. |
| FieldPermissions | Update and Query the available FieldPermissions in kintone. |
| FormFields | Create, update, delete, and query the Form Fields in Kintone. |
| FormLayout | Update and Query the available Form Layout in kintone. |
| GeneralNotifications | Update and Query the available GeneralNotifications in kintone. |
| GeneralSettings | Update and Query the General Settings in kintone. |
| GraphSettings | Update and Query the available Graph Settings in kintone. |
| PerRecordNotifications | Update and Query the available PerRecord Notifications in kintone. |
| ProcessManagement | Update and Query the Process Management in kintone. |
| RecordPermissions | Update and Query the available RecordPermissions in kintone. |
| ReminderNotifications | Update and Query the available Reminder Notifications in kintone. |
| SampleApp | Sample App: Customer Management (Sales Support Pack). |
| SampleApp_Table | Sample App: Customer Management (Sales Support Pack) Detail Table. |
| Space | Create, Update, Delete and Query the available Space in kintone. |
| SpaceMembers | Update and Query the available Space Members in kintone. |
| Views | Update and Query the available Views in kintone. |
Update and Query the available Action Settings in kintone.
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 |
The App ID of the kintone application. | |
| Id [KEY] | String | True |
The ID of the Action. | |
| Index | String | False |
The order of the Action, starting from 0. | |
| Name | String | False |
The name of the Action. | |
| DestApp | String | False |
The App ID of the copy destination app. | |
| DestCode | String | False |
The App Code of the copy destination app. An empty string is returned if an App Code is not set in the destination app's settings. | |
| Mappings | String | False |
An array of objects containing the Field Mappings options. An empty array is returned if the Field Mappings options are not configured. | |
| Entities | String | False |
An array of objects containing the entities the Action is granted to. This reflects the Available To options. Inactive users and deleted users/departments/groups will not be included in the response. | |
| Revision | String | False |
The revision number of the App settings. |
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 |
The localized language to retrieve the data. |
| IsPreview | Boolean |
By setting this to False, you will be able to retrieve the Action Settings details of the live App. Default value is true. |
| Actions | String |
Only used for performing Update. |
Update and Query the App Permissions in kintone.
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 |
The App ID of the kintone application. | |
| EntityType [KEY] | String | False |
The type of the entity the permission is granted to. | |
| EntityCode | String | False |
The code of the entity the permission is granted to. | |
| IncludeSubs | Boolean | False |
The permission inheritance settings of the department the permission is granted to. | |
| AppEditable | Boolean | False |
The App management permission of the entity. Entities with this permission are able to access and edit the App's settings. | |
| RecordViewable | Boolean | False |
The record view permission of the entity. | |
| RecordAddable | Boolean | False |
The record add permission of the entity. | |
| RecordEditable | Boolean | False |
The record edit permission of the entity. | |
| RecordDeletable | Boolean | False |
The record delete permission of the entity. | |
| RecordImportable | Boolean | False |
The file import permission of the entity. | |
| RecordExportable | Boolean | False |
The file export permission of the entity. | |
| Revision | String | True |
The revision number of the App settings. |
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 |
By setting this to False, you will be able to retrieve the App Permissions details of the live App. Default value is true. |
| Rights | String |
Only used for performing Update. |
Query the available comments in kintone.
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 |
The Comment Id. | |
| AppId [KEY] | Integer | False |
The App Id. | |
| RecordId [KEY] | Integer | False |
The Record Id. | |
| Text | String | False |
The comment including the line feed codes. | |
| CreatorCode | String | True |
The user code of the comment creator (log-in name). | |
| CreatorName | String | True |
The user name of the comment creator (display name). | |
| CreatedAt | Datetime | True |
The created date and time of the comment. | |
| MentionsAggregate | String | False |
An array including information of mentioned users. |
Update and Query the available FieldPermissions in kintone.
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 |
The App ID of the kintone application. | |
| Code [KEY] | String | False |
The field code of a field that has permission settings. | |
| Entities | String | False |
An array listing the entities the permissions are granted to, in order of priority. | |
| Revision | String | True |
The revision number of the App settings. |
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 |
By setting this to False, you will be able to retrieve the FieldPermissions details of the live App. Default value is true. |
| Rights | String |
Only used for performing Update. |
Create, update, delete, and query the Form Fields in Kintone.
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
For updating the FormFields, provide the Properties as an aggregate. The AppId column is required to update the FormFields.
UPDATE FormFields SET Properties = '{"Text__single_line_TT":{"code":"Text__single_line_PT","label":"text","type":"SINGLE_LINE_TEXT"}}' WHERE AppId = 6
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 |
The App ID of the kintone application. | |
| Code [KEY] | String | False |
The field code. | |
| Enabled | String | True |
The on/off settings of features. | |
| Label | String | False |
The field name. | |
| NoLabel | Boolean | False |
The Hide field name option. | |
| Type | String | False |
The field type. | |
| Required | String | False |
The Required field option. | |
| Unique | String | False |
The Prohibit duplicate values option. | |
| MaxValue | String | False |
The maximum number of characters for the field. | |
| MinValue | String | False |
The minimum number of characters for the field. | |
| MaxLength | String | False |
The maximum number of digits for the field. | |
| MinLength | String | False |
The minimum number of digits for the field. | |
| DefaultValue | String | False |
The default value. An array will be returned for fields that can set multiple default values. | |
| DefaultNowValue | String | False |
The Default to the record creation date option. | |
| Options | String | False |
An object including data of the field's options. | |
| Align | String | False |
The layout of the options. | |
| Expression | String | False |
The formula expression used in the field. | |
| HideExpression | String | False |
The Hide formula settings for the field. | |
| Digit | String | False |
The Use thousands separators option. | |
| ThumbnailSize | String | False |
The size of the image thumbnail in pixels. | |
| Protocol | String | False |
The Link type settings for the field. | |
| Format | String | False |
The display format for fields with calculations. | |
| DisplayScale | String | False |
The number of decimal places to display for the field. | |
| Unit | String | False |
The Currency settings of the field. | |
| UnitPosition | String | False |
The display position of the Currency. | |
| Entities | String | False |
An array listing the preset users for the field. | |
| ReferenceTable | String | False |
An object containing the settings of the Related Records field. | |
| LookUp | String | False |
An object containing the settings of the Lookup field. | |
| OpenGroup | String | False |
The Show fields in this group option. | |
| Fields | String | False |
An object containing data of fields in a table. The parameters of this object are the same as the properties parameter. | |
| Revision | String | True |
The revision number of the App settings. |
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 |
The localized language to retrieve the data. |
| IsPreview | Boolean |
By setting this to False, you will be able to retrieve the Form Field details of the live App. Default value is true. |
| Properties | String |
Only used for performing Insert or Update. |
Update and Query the available Form Layout in kintone.
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 |
The App ID of the kintone application. | |
| Fields | String | False |
A list of fields in the row. | |
| Type | String | False |
The type of row. The allowed values are ROW, SUBTABLE, GROUP. | |
| Code | String | False |
The field code of the Table or Group field. This parameter will not be returned for other row types. | |
| Revision | String | True |
The revision number of the App settings. |
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 |
By setting this to False, you will be able to retrieve the Form Layout details of the live App. Default value is true. |
| Layout | String |
Only used for performing Insert or Update. |
Update and Query the available GeneralNotifications in kintone.
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 |
The App ID of the kintone application. | |
| EntityType | String | False |
The type of the entity the General Notification settings are configured to. | |
| EntityCode [KEY] | String | False |
The code of the entity the General Notification settings are configured to. | |
| IncludeSubs | Boolean | False |
The Include affiliated departments setting of the Department. Will always return false unless the notifications[].entity.type is set to ORGANIZATION or FIELD_ENTITY for a Department Selection Field. | |
| RecordAdded | Boolean | False |
Option to notify the entity when a record is added. | |
| RecordEdited | Boolean | False |
Option to notify the entity when a record is edited. | |
| CommentAdded | Boolean | False |
Option to notify the entity when a comment is posted. | |
| StatusChanged | Boolean | False |
Option to notify the entity when a status is changed. | |
| FileImported | Boolean | False |
Option to notify the entity when a file is imported. | |
| NotifyToCommenter | Boolean | False |
Option to notify all commenters of a record when a comment is posted on that record. This reflects the Send updated comment notifications to all commenters checkbox. | |
| Revision | String | True |
The revision number of the App settings. |
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 |
By setting this to False, you will be able to retrieve the GeneralNotifications details of the live App. Default value is true. |
| Notifications | String |
Only used for performing Update. |
Update and Query the General Settings in kintone.
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 |
The App ID of the kintone application. | |
| IconKey [KEY] | String | False |
The key identifier of the icon. Responded, if the preset icons within Kintone are used. | |
| IconType | String | False |
The icon type: FILE, PRESET. | |
| IconFile | String | False |
The icon type: FILE, PRESET. | |
| Name | String | False |
The App name. | |
| Description | String | False |
The app description in HTML format. | |
| Theme | String | False |
The color theme. | |
| Revision | String | True |
The revision number of the App settings. |
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 |
The localized language to retrieve the data. |
| IsPreview | Boolean |
By setting this to False, you will be able to retrieve the General Settings details of the live App. Default value is true. |
Update and Query the available Graph Settings in kintone.
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 |
The App ID of the kintone application. | |
| Id [KEY] | String | True |
The ID of the graph. | |
| Index | String | False |
The order of the graphs, starting from 0. | |
| Name | String | False |
The name of the graph. The maximum limit is 64 characters. When the lang request parameter is specified, the graph's name in that language will be returned. | |
| PeriodicReport | String | False |
An objects containing the Periodic Reports (External link) options. If the Generate reports periodically option have never been configured, null will be returned. | |
| Sorts | String | False |
An array of objects containing the Sort by options. | |
| Aggregations | String | False |
The type of the Function option. | |
| ChartMode | String | False |
The display mode (External link) of the graph. | |
| ChartType | String | False |
The chart type (External link) of the graph. | |
| FilterCond | String | False |
The record's filter condition in query string format that reflects the Filter option. | |
| Groups | String | False |
The type of the Function option. | |
| Revision | String | True |
The revision number of the App settings. |
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 |
The localized language to retrieve the data. |
| IsPreview | Boolean |
By setting this to False, you will be able to retrieve the Graph Settings details of the live App. Default value is true. |
| Reports | String |
Only used for performing Update. |
Update and Query the available PerRecord Notifications in kintone.
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 |
The App ID of the kintone application. | |
| FilterCond | String | False |
The record's filter condition in query string format. | |
| Title [KEY] | String | False |
The notification subject that is saved under Summary. | |
| Targets | String | False |
An array of objects containing the recipients of the Per Record Notification. | |
| Revision | String | True |
The revision number of the App settings. |
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 |
The localized language to retrieve the data. |
| IsPreview | Boolean |
By setting this to False, you will be able to retrieve the PerRecordNotifications details of the live App. Default value is true. |
| Notifications | String |
Only used for performing Update. |
Update and Query the Process Management in kintone.
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 |
The App ID of the kintone application. | |
| Enable | Boolean | False |
The on/off settings of the process management settings. | |
| Actions | String | False |
An array containing data of the Actions. They are listed in the same order as in the GUI. Null is returned for Apps that have never enabled the process management settings before. | |
| Revision | String | True |
The revision number of the App settings. | |
| Name | String | False |
The status name. | |
| Index | String | False |
The display order (ascending) of the Status, when listed with the other statuses. | |
| AssigneeType | String | False |
The Assignee List type of the Status. | |
| AssigneeEntities | String | False |
An array listing data of the Assignees. They are listed in the same order as in the GUI. |
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 |
The localized language to retrieve the data. |
| IsPreview | Boolean |
By setting this to False, you will be able to retrieve the Process Management details of the live App. Default value is true. |
| States | String |
Only used for performing Update. |
Update and Query the available RecordPermissions in kintone.
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 |
The App ID of the kintone application. | |
| FilterCond | String | False |
The filter condition of the record permission. | |
| Entities | String | False |
An array listing the entities the permissions are granted to, in order of priority. | |
| Revision | String | False |
The revision number of the App settings. |
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 |
The localized language to retrieve the data. |
| IsPreview | Boolean |
By setting this to False, you will be able to retrieve the RecordPermissions details of the live App. Default value is true. |
| Rights | String |
Only used for performing Update. |
Update and Query the available Reminder Notifications in kintone.
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 |
The App ID of the kintone application. | |
| FilterCond | String | False |
The record's filter condition in query string format. | |
| Title | String | False |
The notification subject that is saved under Summary. | |
| TimingCode [KEY] | String | False |
The field code of the field used to determine the Reminder notification's timing. | |
| TimingDaysLater | Integer | False |
The number of days after the notifications[].timing.code date/datetime when the Reminder notification is sent. A negative value indicates the number of days before the notifications[].timing.code date/datetime. | |
| TimingHoursLater | Integer | False |
The number of hours after the notifications[].timing.code datetime, shifted by daysLater, when the Reminder notification is sent. | |
| TimingTime | String | False |
The time when the Reminder notification is sent. The parameter is returned if the notifications[].timing.code parameter is set to a date field or the | |
| Targets | String | False |
An array of objects containing the recipients of the Reminder Notification. | |
| Revision | String | True |
The revision number of the App settings. | |
| Timezone | String | False |
The timezone that determines the Reminder notification's timing. This reflects the Reminder Time Zone dropdown option. If the App's Reminder Notification settings have never been configured, null will be returned. |
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 |
The localized language to retrieve the data. |
| IsPreview | Boolean |
By setting this to False, you will be able to retrieve the Reminder Notifications details of the live App. Default value is true. |
| Notifications | String |
Only used for performing Update. |
Sample App: Customer Management (Sales Support Pack).
| Name | Type | ReadOnly | References | Description |
| RecordId | Int | True |
Sample: Record ID | |
| Revision | Int | True |
Sample: Revision | |
| AppId | Int | True |
Sample: App ID | |
| Remarks | String | True |
Sample: Remarks | |
| UpdaterCode | String | True |
Sample: Updater Code | |
| UpdaterName | String | True |
Sample: Updater Name | |
| CreatorCode | String | True |
Sample: Creator Code | |
| CreatorName | String | True |
Sample: Creator Name | |
| PostalCode | String | True |
Sample: Postal Code | |
| DepartmentName | String | True |
Sample: Department Name | |
| EmailAddress | String | True |
Sample: Email Address | |
| PersonInChargeName | String | True |
Sample: Person in Charge Name | |
| UpdateDateAndTime | Datetime | True |
Sample: Update Date and Time | |
| CustomerName | String | True |
Sample: Customer Name | |
| Address | String | True |
Sample: Address | |
| TEL | String | True |
Sample: TEL |
Sample App: Customer Management (Sales Support Pack) Detail Table.
| Name | Type | ReadOnly | References | Description |
| CustomerManagementId | Int | True |
Sample: Customer Management (Sales Support Pack) Id | |
| Id | Int | True |
Sample: Id | |
| Revision | Int | True |
Sample: Revision | |
| AppId | Int | True |
Sample: App ID | |
| ProjectName | String | True |
Sample: Project Name | |
| Probability | String | True |
Sample: Probability | |
| ExpectedOrderDate | Datetime | True |
Sample: Expected Order Date | |
| TotalCost | Double | True |
Sample: Total Cost | |
| SalesRepresentativeAggregate | String | True |
Sample: Sales Representative Aggregate |
Create, Update, Delete and Query the available Space in kintone.
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 Space WHERE Id = 7
The SpaceTemplateID, Name, Members columns are required in the INSERT statement.
INSERT INTO Space(SpaceTemplateID, Name, Members) Values(1, 'New_Space', '[{"entity":{"type":"USER","code":"[email protected]"},"isAdmin":true}]')
The Id column is required to update the Space.
UPDATE Space SET body='Space Body' WHERE Id = 16
The Id column is required to delete the Space.
DELETE FROM Space WHERE Id = 16
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The Space ID. | |
| Name | String | False |
The name of the Space. | |
| DefaultThread | String | False |
The Thread ID of the default thread that was created when the Space was made. | |
| IsPrivate | Boolean | False |
The Private settings of the Space. | |
| CreatorCode | String | False |
The code (log in name) of the creator. An empty string is returned for inactive or deleted users. | |
| CreatorName | String | False |
The display name of the creator. An empty string is returned for inactive or deleted users. | |
| ModifierCode | String | False |
The code (log in name) of the updater. An empty string is returned for inactive or deleted users. | |
| ModifierName | String | False |
The display name of the updater. An empty string is returned for inactive or deleted users. | |
| MemberCount | String | False |
The number of members of the Space. | |
| CoverType | String | False |
The image type of the Cover Photo. | |
| CoverKey | String | False |
The key of the Cover Photo. | |
| CoverUrl | String | False |
The URL of the Cover Photo. | |
| Body | String | False |
The HTML of the Space body. Null is returned if the HTML in the body is empty. However, if the body has been set before, the HTML tags may be set even if nothing is displayed on the screen and the string will be returned. | |
| UseMultiThread | Boolean | False |
The Enable multiple threads setting. | |
| IsGuest | Boolean | False |
The Guest Space setting. | |
| FixedMember | Boolean | False | ||
| AttachedApps | String | False |
A list of Apps that are in the thread. This does not include Apps that are not live yet. | |
| ShowAnnouncement | Boolean | False |
The display status for the Announcement widget. | |
| ShowThreadList | Boolean | False |
The display status for the Threads widget. | |
| ShowAppList | Boolean | False |
The display status for the Apps widget. | |
| ShowMemberList | Boolean | False |
The display status for the People widget. | |
| ShowRelatedLinkList | Boolean | False |
The display status for the Related Apps and Spaces widget. |
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 |
The Space Template ID. It is required while creating a new Space. |
| Members | String |
A list of members of the Space. It is required while creating a new Space. At least one Space Administrator must be specified. Inactive and deleted users cannot be specified. |
Update and Query the available Space Members in kintone.
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 |
The Space ID. | |
| EntityCode | String | False |
The code of the Space member. | |
| EntityType | String | False |
The entity type of the Space member. | |
| IsAdmin | Boolean | False |
The Space Admin settings of the Space member. | |
| IsImplicit | Boolean | False |
If the Space Member is added as a User or not. | |
| IncludeSubs | Boolean | False |
The Include Affiliated Departments setting of the Department Space Member. |
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 |
A list of members of the Space. It is required while creating a new Space. At least one Space Administrator must be specified. Inactive and deleted users cannot be specified. |
Update and Query the available Views in kintone.
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 |
The View ID. | |
| AppId | Integer | False |
The App ID of the kintone application. | |
| Index | String | False |
The display order (ascending) of the View, when listed with other views. | |
| Name | String | False |
The name of the View. | |
| Title | String | False |
The field code set for the Title Field. Responded for Calendar Views. | |
| Type | String | False |
The type of View. The allowed values are LIST, CALENDAR, CUSTOM. | |
| BuiltinType | String | False |
The type of the built-in View. | |
| Date | String | False |
The field code set for the Date Field. Responded for Calendar Views. | |
| Fields | String | False |
The list of field codes for the fields displayed in the View. | |
| FilterCond | String | False |
The filter condition as a query. | |
| Html | String | False |
The HTML code set for the View. Responded for Custom Views. | |
| Pager | Boolean | False |
The pagination settings. Responded for Custom Views. | |
| Device | String | False |
The scope of where the view is displayed. | |
| Sort | String | False |
The sort order as a query. | |
| Revision | String | True |
The revision number of the App settings. |
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 |
The localized language to retrieve the data. |
| IsPreview | Boolean |
By setting this to False, you will be able to retrieve the Views details of the live App. Default value is true. |
| Views | String |
Only used for performing Update. |
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 | Query the available Action Settings Entities in kintone. |
| ActionSettingsMappings | Query the available Action Settings Mappings in kintone. |
| Apps | Query the available apps in kintone. |
| FieldPermissionsEntities | Query the Field Permissions Entities in kintone. |
| FormLayoutFields | Query the available Form Layout Fields in kintone. |
| PerRecordNotificationsTargets | Query the PerRecord Notifications Targets in kintone. |
| ProcessManagementActions | Query the Process Management Actions in kintone. |
| RecordPermissionsEntities | Query the available Record Permissions Entities in kintone. |
| ReminderNotificationsTargets | Query the available Reminder Notifications Targets in kintone. |
Query the available Action Settings Entities in kintone.
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 | The App ID of the kintone application. | |
| Id | String | The ID of the Action. | |
| Code | String | The code of the entity the Action is granted to. For guest users, the login name is preceded by guest/. | |
| Type | String | The type of the entity the Action is granted to.
The allowed values are USER, GROUP, ORGANIZATION. | |
| Revision | String | The revision number of the App settings. |
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 | The localized language to retrieve the data. | |
| IsPreview | Boolean | By setting this to False, you will be able to retrieve the Action Settings details of the live App. Default value is true. |
Query the available Action Settings Mappings in kintone.
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 | The App ID of the kintone application. | |
| Id | String | The ID of the Action. | |
| SrcType | String | The type of source data that is to be copied.
The allowed values are FIELD, RECORD_URL. | |
| SrcField | String | The field code of the field specified in the Field Mappings options as the source. This parameter is returned only if the actions.{actionname}.mappings[].srcType parameter is set to FIELD. | |
| DestField | String | The field code of the field specified in the Field Mappings options as the destination. | |
| Revision | String | The revision number of the App settings. |
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 | The localized language to retrieve the data. | |
| IsPreview | Boolean | By setting this to False, you will be able to retrieve the Action Settings details of the live App. Default value is true. |
Query the available apps in kintone.
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 | The App ID of the kintone application. | |
| Code | String | The App Code of the app. This will be blank if an App Code is not set in the settings of the App. | |
| Name | String | The name of the App. If Localization settings are used, this column will return the localized name dependant on the language settings of the kintone user using this API. | |
| Description | String | The description of the App. If Localization settings are used, this column will return the localized app description dependent on the language settings of the kintone user using this API. | |
| SpaceId | String | If the app was created inside a space, this column will return the space Id. If not, this column returns null. | |
| ThreadId | String | If the app was created inside a space, this column will return the thread Id of the thread of the space it belongs to. For users who have not altered their User Interface Settings to the classic design, apps will automatically belong to the first thread of the space when the app is made in the space. Users who use the classic design will find that they can create apps that are thread-specific instead of space-specific. If the app was not created in a space, null is returned. | |
| CreatedAt | Datetime | The date of when the app was created. | |
| CreatorCode | String | The log-in name of the creator. Nothing is returned for inactive users and deleted users. | |
| CreatorName | String | The display name of the creator. Nothing is returned for inactive users and deleted users. | |
| ModifiedAt | Datetime | The date of when the app was last modified. | |
| ModifierCode | String | The log-in name of the last updater. Nothing is returned for inactive users and deleted users. | |
| ModifierName | String | The display name of the last updater. Nothing is returned for inactive users and deleted users. | |
| Alias | String | The alias name of the App. |
Query the Field Permissions Entities in kintone.
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 | The App ID of the kintone application. | |
| Code [KEY] | String | The field code of a field that has permission settings. | |
| EntityType | String | The type of the entity the permission is granted to. | |
| EntityCode | String | The code of the entity the permission is granted to. | |
| Accessibility | String | The permission granted to the entity.
The allowed values are READ, WRITE, NONE. | |
| IncludeSubs | Boolean | The permission inheritance settings of the department the permission is granted to. |
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 | By setting this to False, you will be able to retrieve the FieldPermissions details of the live App. Default value is true. |
Query the available Form Layout Fields in kintone.
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 | The App ID of the kintone application. | |
| Code | String | The field code. | |
| Type | String | The type of field. | |
| ElementId | String | The element ID of the Space field. Only returned for Space fields. | |
| Label | String | The text set in the Label field. Only returned for Label fields. | |
| Width | String | The width of the field in pixels. | |
| Height | String | The height of the field in pixels, including the height of the field name. | |
| InnerHeight | String | The height of the field in pixels, excluding the height of the field name. |
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 | By setting this to False, you will be able to retrieve the Form Layout details of the live App. Default value is true. |
Query the PerRecord Notifications Targets in kintone.
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 | The App ID of the kintone application. | |
| Title | String | The notification subject that is saved under Summary. | |
| EntityType | String | The type of the entity the Per Record Notification settings are configured to. | |
| EntityCode | String | The code of the entity the Per Record Notification settings are configured to. | |
| IncludeSubs | Boolean | The Include affiliated departments setting of the Department. |
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 | The localized language to retrieve the data. | |
| IsPreview | Boolean | By setting this to False, you will be able to retrieve the PerRecord Notifications Targets details of the live App. Default value is true. |
Query the Process Management Actions in kintone.
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 | The App ID of the kintone application. | |
| Name | String | The Action name. | |
| From | String | The status before taking action. | |
| To | String | The status after taking action. | |
| FilterCond | String | The branch criteria of the action. |
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 | The localized language to retrieve the data. | |
| IsPreview | Boolean | By setting this to False, you will be able to retrieve the Process Management Actions details of the live App. Default value is true. |
Query the available Record Permissions Entities in kintone.
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 | The App ID of the kintone application. | |
| FilterCond | String | The filter condition of the record permission. | |
| EntityType | String | The type of the entity the permission is granted to. | |
| EntityCode | String | The code of the entity the permission is granted to. | |
| Viewable | Boolean | The view permission of the entity. | |
| Editable | Boolean | The edit permission of the entity. | |
| Deletable | Boolean | The delete permission of the entity. | |
| IncludeSubs | Boolean | The permission inheritance settings of the department the permission is granted to. |
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 | The localized language to retrieve the data. | |
| IsPreview | Boolean | By setting this to False, you will be able to retrieve the Record Permissions Entities details of the live App. Default value is true. |
Query the available Reminder Notifications Targets in kintone.
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 | The App ID of the kintone application. | |
| TimingCode [KEY] | String | The field code of the field used to determine the Reminder notification's timing. | |
| EntityType | String | The type of the entity the Reminder Notification settings are configured to. | |
| EntityCode | String | The code of the entity the Reminder Notification settings are configured to. | |
| IncludeSubs | Boolean | The Include affiliated departments setting of the Department. The Include affiliated departments setting of the Department. |
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 | The localized language to retrieve the data. | |
| IsPreview | Boolean | By setting this to False, you will be able to retrieve the Reminder Notifications Targets details of the live App. Default value is true. |
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 | Gets information of Departments that a User belongs to, and Job Title information related to the Department. |
| UserGroups | Gets information of Groups that a User belongs to. |
| Users | Gets information of users. |
Gets information of Departments that a User belongs to, and Job Title information related to the Department.
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 | The ID of the Department. | |
| TitleId [KEY] | Long | The ID of the Job Title. | |
| OrganizationCode | String | The Code of the Department. | |
| OrganizationName | String | The display name of the Department. | |
| OrganizationLocalName | String | The localized name of the Department. | |
| OrganizationLocalNameLocale | String | The locale of the localized name of the Department. | |
| OrganizationParentCode | String | The code of the Parent Department. null, if the parent is the Root. | |
| OrganizationDescription | String | The description of the Department. | |
| TitleCode | String | The code of the Job Title. | |
| TitleName | String | The name of the Job Title. | |
| TitleDescription | String | The description 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 | The log in name of the User. |
Gets information of Groups that a User belongs to.
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 | The ID of the Group. | |
| GroupCode | String | The code of the Group. | |
| GroupName | String | The display name of the Group. | |
| GroupDescription | String | The description 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 | The log in name of the User. |
Gets information of users.
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 | The user ID. | |
| Code | String | The log in name of the User. | |
| CreatedTime | Datetime | The created datetime of the User. | |
| UpdatedTime | Datetime | The updated datetime of the User. | |
| Valid | Boolean | If the Status of the user is Active or not. | |
| Name | String | The display name of the User. | |
| SurName | String | The last name of the User. | |
| GivenName | String | The first name of the User. | |
| SurNameReading | String | The phonetic reading of the Last name. | |
| GivenNameReading | String | The phonetic reading of the First name. | |
| LocalName | String | The localized display name of the User. | |
| LocalNameLocale | String | The locale of the localized display name of the User. | |
| Timezone | String | The time zone ID of the user's set time zone. | |
| Locale | String | The language setting of the user. | |
| Description | String | The About Me section of the user's profile. | |
| Phone | String | The phone number of the User. | |
| MobilePhone | String | The mobile phone number of the User. | |
| ExtensionNumber | String | The extension number of the User. | |
| String | The Email address of the User. | ||
| SkypeID | String | The Skype ID of the User. | |
| Url | String | The URL section of the user's profile. | |
| EmployeeNumber | String | The Employee Number of the User. | |
| BirthDate | Datetime | The Birthday of the User. | |
| JoinDate | Datetime | The Hire Date of the User. | |
| PrimaryOrganization | Integer | The Department ID of the Priority Department of the User. Set to null if there is no Priority Department. | |
| SortOrder | Integer | The Display Order priority of the User. | |
| CustomItemValues | String | A list of pairs of Custom Field Names and Custom Field Codes. |
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 user ID of the authenticating Kintone user account. |
| Password | Specifies the password of the authenticating user account. |
| 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 that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
| 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 | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) 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 | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | 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 rows returned for queries without aggregation or GROUP BY. |
| NumberMapToDouble | Determines whether or not to change the datatype of number fields from decimal to double. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| Pagesize | Specifies the maximum number of results to return from Kintone, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| SubtableSeparatorCharacter | The character used for dividing tables from subtables in the format tablename + char + subtable. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| 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 defining custom views. The provider automatically detects and uses the views specified in this file. |
| UseSimpleNames | Boolean determining if 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 user ID of the authenticating Kintone user account. |
| Password | Specifies the password of the authenticating user account. |
| 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 user ID of the authenticating Kintone user account.
The authenticating server requires both User and Password to validate the user's identity.
Specifies the password of the authenticating user account.
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 that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
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 | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) 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 | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | 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. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of the proxy server that you want to route HTTP traffic through.
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, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is 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.
The authentication type can be one of the following:
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.
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 user name of a user registered with the proxy server. |
| DIGEST | The user name 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. |
The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.
The password associated with 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.
The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.
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. |
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 that 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.
This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.
For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.
The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.
For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.
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 rows returned for queries without aggregation or GROUP BY. |
| NumberMapToDouble | Determines whether or not to change the datatype of number fields from decimal to double. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| Pagesize | Specifies the maximum number of results to return from Kintone, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| SubtableSeparatorCharacter | The character used for dividing tables from subtables in the format tablename + char + subtable. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| 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 defining custom views. The provider automatically detects and uses the views specified in this file. |
| UseSimpleNames | Boolean determining if 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 rows returned for queries without aggregation or GROUP BY.
This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.
When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.
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 additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in 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.
Specify multiple properties in a semicolon-separated list.
| 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 | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the maximum number of results to return from Kintone, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.
Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
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: "*=*"
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.
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.
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.
Setting this property to 0 disables the timeout, allowing 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. 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 defining custom views. The provider automatically detects and uses the views specified in this file.
This property 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 define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.
Refer to User Defined Views for more information.
Boolean determining if simple names should be used for tables and columns.
Kintone tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the Sync App easier to use with traditional database tools.
Setting UseSimpleNames to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.
Determines whether to display unit with Field Name.
If set to false, Unit will not be displayed with Field Name.