This page provides a guide to Establishing a Connection to Kintone in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Kintone

Establishing a Connection shows how to authenticate to Kintone and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Kintone through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Kintone by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Kintone

In addition to the authentication values, set the following parameters to connect to and retrieve data from Kintone:

• URL: The URL of your account.
• GuestSpaceId: Optional. Set this when using a guest space.

Kintone REST API

Set Schema to "Kintone" for connecting to Kintone REST API.

Kintone REST API supports following authentication schemes:

• Password Authentication
• API Token
• OAuth Authentication

Kintone USER API

Set Schema to "CybozuUser" for connecting to Kintone USER API.

Kintone USER API supports following authentication scheme:

• Password Authentication

Authenticating to Kintone

Kintone supports the following authentication methods.

Password Authentication

You must set the following to authenticate to Kintone:

• User: The username of your account.
• Password: The password of your account.
• AuthScheme: Set AuthScheme to Password.

API Token

You must set the following to authenticate to Kintone:

• APIToken: The API Token.

  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.

• AppId: The Application Ids.

  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.

• AuthScheme: Set AuthScheme to APIToken.

Additional Security

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.

Using Client SSL

In addition to your authentication information, Kintone may be configured to require an SSL certificate to accept requests. To do so, set the following:

• SSLClientCert: The file containing the certificate of the SSL Cert. Or alternatively, the name of the certificate store for the client certificate.
• SSLClientCertType: The type of certificate.
• SSLClientCertSubject: (Optional) If searching for a certificate in the certificate store, the store is searched for subjects containing the value of the property.
• SSLClientCertPassword: If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.

Basic

Kintone environments using basic authentication will need to pass additional basic credentials. To do so, specify the following:

• BasicAuthUser: The basic login name.
• BasicAuthPassword: The basic password.

OAuth Authentication

If you do not have access to the user name and password or do not want to require them, use the OAuth user consent flow. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth and create a custom OAuth application.

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 Cloud automatically refresh the OAuth access token:

1. Before connecting to data for the first time, set these connection parameters:
   • InitiateOAuth: REFRESH.
   • OAuthClientId: The client Id in your custom OAuth application settings.
   • OAuthClientSecret: The client secret in your custom OAuth application settings.
   • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation: The path where you want the Cloud to save the OAuth values, which persist across connections.
   • UseCursor: FALSE.
2. On subsequent data connections, set:
   • InitiateOAuth
   • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set these connection properties:
   • OAuthClientId: The Client Id in your custom OAuth application settings.
   • OAuthClientSecret: The Client Secret in your custom OAuth application settings.

3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Creating a Custom OAuth Application

If you do not have access to the user name and password or do not wish to require them, you can use OAuth authentication. Kintone uses the OAuth authentication standard, which requires the authenticating user to interact with Kintone via the browser. Authenticating via OAuth requires the use of the OAuth client credentials, client Id, and client secret.

To register a custom OAuth application and obtain the OAuth client credentials, client id, and client secret:

1. Log into your Kintone and navigate to the User & System Administration page.
2. Click on OAuth under System Administration.
3. Click on the green Add OAuth Client button under Set up Advanced Services.
4. Enter in the details of the OAuth client.
5. Enter a value for the application's Redirect URI:
   • If you are making a desktop application, set the Callback URL to http://localhost:33333 or a different port number of your choice.
   • If you are making a web application, set the Callback URL to a page on your Web app that you want the user to be returned to after they have authorized your application.

6. When you have filled in all required fields, click Save.

Enabled applications are displayed in the list and the process completes.

The OAuthClientId and ClientSecret are displayed along with the information you specified when setting up the application. Record the OAuthClientID and ClientSecret for future use.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Using Kintone REST API

See Kintone Data Model for the available entities in the Kintone Data Model.

Using Kintone USER API

See CybozuUser Data Model for the available entities in the CybozuUSER Data Model.

The Cloud models the Kintone REST API as relational Tables, Views and Stored Procedures.

Tables

Using the Cloud, 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 Cloud 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 Cloud installation folder.

Sub-Tables

In some Kintone apps, the user can add custom fields containing many records. The Cloud models these fields as dynamic subtables reflecting your changes.

Stored Procedures

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.

Views

The Cloud models apps in the static Apps view.

The Cloud models the data in Kintone as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Kintone Tables

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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM ActionSettings WHERE AppId = 6
SELECT * FROM ActionSettings WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ActionSettings WHERE AppId = 6 AND IsPreview = false

Update

For updating the ActionSettings, provide the Actions as an aggregate. The AppId column is required to update the ActionSettings.

UPDATE ActionSettings SET Actions = '{"Action_Z":{"name":"Action_A","index":"0"}}' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId	Integer	False		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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Lang	String	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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM AppPermissions WHERE AppId = 6
SELECT * FROM AppPermissions WHERE AppId = 6 AND IsPreview = false

Update

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
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.

Select

The RecordId and AppId columns are required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by these columns. The Kintone APIs also support filters on Id. By default, the Cloud will process other filters client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM Comments WHERE RecordId = 1 AND AppId = 5 AND Id = 1

Insert

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"}]')

Delete

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

Columns

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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM FieldPermissions WHERE AppId = 6
SELECT * FROM FieldPermissions WHERE AppId = 6 AND IsPreview = false

Update

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

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

Insert

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

Update

You can update FormFields in two different ways, depending on your use case:

Method 1: Update Using the Properties Column, If you want to update multiple form field details at once, you can use the Properties column. This column expects a JSON object that includes field attributes like code, label, and type etc. In this Method AppId column is required in where clause.

UPDATE FormFields SET Properties = '{"Text__single_line_TT":{"code":"Text__single_line_PT","label":"text","type":"SINGLE_LINE_TEXT"}}' WHERE AppId = 6

Method 2: Update Individual Columns, You can also update individual fields like label, code etc. directly without using the Properties column but this will update one field at a time. In this Method both AppId and Code columns are required in where clause.

UPDATE FormFields SET label='text', code='Item_update', type='SINGLE_LINE_TEXT' where appId=444 and code='Item';

Delete

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Lang	String	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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

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

Update

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM GeneralNotifications WHERE AppId = 6
SELECT * FROM GeneralNotifications WHERE AppId = 6 AND IsPreview = false

Update

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM GeneralSettings WHERE AppId = 6
SELECT * FROM GeneralSettings WHERE AppId = 6 AND IsPreview = false

Update

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

Columns

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		An object containing data of uploaded icon files.
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.
TitleFieldSelectionMode	String	False		The option of The field to be used as the record title settings: AUTO, MANUAL.
TitleFieldCode	String	False		The field code of the field used as the title of the record.
EnableBulkDeletion	Boolean	False		The Enable bulk deletion of records setting.
EnableComments	Boolean	False		The Enable comments setting.
EnableDuplicateRecord	Boolean	False		The Enable the feature to
EnableThumbnails	Boolean	False		The Show thumbnails setting.
FirstMonthOfFiscalYear	Integer	False		The First month of Fiscal Year setting. The number of the month will be returned.
NumberPrecisionDecimalPlaces	Integer	False		The Number of Decimal Places to Round setting.
NumberPrecisionDigits	Integer	False		The Total Number of Digits setting.
NumberPrecisionRoundingMode	String	False		The Rounding setting: HALF_EVEN, UP, DOWN.
EnableInlineRecordEditing	Boolean	False		Whether to enable inline editing in the record list

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Lang	String	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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

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

Update

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Lang	String	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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

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

Update

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Lang	String	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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

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

Update

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Lang	String	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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

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

Update

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Lang	String	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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

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

Update

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Lang	String	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).

Columns

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.

Columns

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.

Select

The Id column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM Space WHERE Id = 7

Insert

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}]')

Update

The Id column is required to update the Space.

UPDATE Space SET body='Space Body' WHERE Id = 16

Delete

The Id column is required to delete the Space.

DELETE FROM Space WHERE Id = 16

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
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.

Select

The Id column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM SpaceMembers WHERE Id = 1

Update

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

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

Update

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Lang	String	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.

CData Cloud - Kintone Views

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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Lang	String		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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Lang	String		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.

Select

By default, the Cloud will use the Kintone APIs to process search criteria that refer to the following columns and will process other filters client-side within the Cloud: 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%'

Columns

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. Use connection property TableNameMode=AppId to make this column as unique.
ItemUrl	String		The unique URL of the app, used to identify and access the specific app on Kintone.

Query the Field Permissions Entities in kintone.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM FieldPermissionsEntities WHERE AppId = 6
SELECT * FROM FieldPermissionsEntities WHERE AppId = 6 AND IsPreview = false

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Lang	String		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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Lang	String		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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Lang	String		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.

Select

The AppId column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

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

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Lang	String		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.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Kintone.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Kintone, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Kintone Stored Procedures

Name	Description
AddGuests	Adds Guest users to Kintone. This does not affiliate Guest users with any Guest Spaces, and does not send any invitation emails. To affiliate a Guest user with a Guest Space, use the AddGuestsToSpace Stored Procedure. Only Kintone Administrators can use this API.
AddGuestsToSpace	Add the Guest users with a Guest Space. Only the Guest Space Administrator can use this API.
AddThreadComment	Adds a comment to a Thread of a Space.
AppsDeployStatus	Get app deployment statuses.
CreateApp	Creates apps.
DeleteGuests	Deletes a Guest user from Kintone. Only Kintone Administrators can use this API.
DeployApps	Deploys apps.
UpdateAssignees	Updates assignees.
UpdateStatus	Updates the status of an app record.
UpdateThread	Updates a Thread of a Space.

Adds Guest users to Kintone. This does not affiliate Guest users with any Guest Spaces, and does not send any invitation emails. To affiliate a Guest user with a Guest Space, use the AddGuestsToSpace Stored Procedure. Only Kintone Administrators can use this API.

Stored Procedure Specific Information

Kintone allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:

Insert into GuestsAggregate#TEMP(Name, Code, Password, Timezone) Values('Jack', '[email protected]', '#jack@123', 'America/Los_Angeles')
Insert into GuestsAggregate#TEMP(Name, Code, Password, Timezone) Values('Geeky', '[email protected]', '#geeky@321', 'America/Los_Angeles')
EXECUTE AddGuests GuestsAggregate = 'GuestsAggregate#TEMP'

The second way of using the Stored Procedure is by adding the aggregate itself:

EXECUTE AddGuests GuestsAggregate = '[{"code":"[email protected]","password":"#abcd@123","timezone":"America/Los_Angeles","locale":"en","name":"John Doe","company":"Company Name","division":"Sales","callto":"skypecallto"}]'

Input

Name	Type	Required	Description
Name	String	False	The display name of the user. Must be between 1 - 128 characters.
Code	String	False	The email address (log in name) of the Guest user.
Password	String	False	The log in password of the Guest user. It must be alphanumeric.
Timezone	String	False	The timezone of the Guest user.
Locale	String	False	The language settings of the Guest user. Available values are auto, en, zh, ja. If not provided, auto will be set as default.
Image	String	False	The profile image of the Guest user. Specify a fileKey of an uploaded file.
SurNameReading	String	False	The Phonetic Surname settings of the Guest User. The maximum limit is 64 characters.
GivenNameReading	String	False	The Phonetic Given Name settings of the Guest User. The maximum limit is 64 characters.
Company	String	False	The Company name to display on the Guest User's profile.
Division	String	False	The Department name to display on the Guest User's profile.
Phone	String	False	The Phone number to display on the Guest User's profile.
CallTo	String	False	The Skype Name of the Guest user.
GuestsAggregate	String	False	The Guests Aggregate.

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Add the Guest users with a Guest Space. Only the Guest Space Administrator can use this API.

Stored Procedure Specific Information

Kintone allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:

EXECUTE AddGuestsToSpace GuestSpaceId = '6', Guests = '["[email protected]","[email protected]","[email protected]"]'

Input

Name	Type	Required	Description
GuestSpaceId	String	True	The Guest Space ID.
Guests	String	True	A list of email addresses of Guest users.

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Adds a comment to a Thread of a Space.

Stored Procedure Specific Information

Kintone allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:

EXECUTE AddThreadComment SpaceId = 8, ThreadId = 8, Text = 'Test Comment'

Input

Name	Type	Required	Description
SpaceId	Integer	True	The Id of the space.
ThreadId	Integer	True	The Id of the thread.
Text	String	False	The comment contents. A line break can be specified by LF. The maximum characters of the comment is 65535. Required, if files is not set.
Mentions	String	False	An array including mentions, that notify other Kintone users.
Files	String	False	An array including data of attachment files. The maximum number of the files is 5. Required, if text is not set.

Result Set Columns

Name	Type	Description
Id	String	The comment ID of the created comment.
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Get app deployment statuses.

Input

Name	Type	Required	Description
AppIds	String	True	The Id of the app. This can be a list of comma-separated Ids.
GuestSpaceId	String	False	This parameter is used for apps that are in the guest space. Do not add this parameter if the connection property GuestSpaceId is specified in the connection string.

Result Set Columns

Name	Type	Description
AppId	String	The Id of the app.
Status	String	The status of the app.

Creates apps.

Input

Name	Type	Required	Description
Name	String	True	Specify the name of the application in less than 64 characters.
Space	String	False	The Id of the space. Do not specify this if the connection property GuestSpaceId is set in the connection string.
ThreadId	String	False	The Id of the thread. This is required if the Space parameter or the connection property GuestSpaceId is specified.
IsGuestSpace	Boolean	False	This is a boolean value that indicates whether the Space parameter is a normal space or a guest space. Set this value to true for guest spaces. The default value is false.

Result Set Columns

Name	Type	Description
AppId	String	The Id of the app.
Revision	String	The revision of the app.
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Deletes a Guest user from Kintone. Only Kintone Administrators can use this API.

Stored Procedure Specific Information

Kintone allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:

For Deleting the Guests, provide the comma separated values of Guests.

EXECUTE DeleteGuests Guests = '["[email protected]","[email protected]"]'

Input

Name	Type	Required	Description
Guests	String	True	A list of email addresses of Guest users. Up to 100 Guests can be deleted.

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Deploys apps.

Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the table below, indexed parameters are denoted with a '#' character at the end of their names.

Input

Name	Type	Required	Description
AppId#	String	True	The App Id. This can be a list of comma-separated Ids.
Revision#	String	False	Specify the revision of the setting that reflects the operational environment. If the specified revision is not up to date, the request will fail.
Revert	Boolean	False	If you want to cancel the change to the application settings, set this to true. The default value is false.
GuestSpaceId	String	False	This parameter is used for apps that are in the guest space. Do not add this parameter if the connection property GuestSpaceid is specified in the connection string.

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Updates assignees.

Input

Name	Type	Required	Description
AppId	String	True	The App Id.
RecordId	String	True	The record Id.
Assignees	String	True	The user codes of the assignees. If empty, no users will be assigned. The maximum number of assignees is 100.
Revision	String	False	The revision number of the record before updating the assignees. If the specified revision is not the latest revision, the request will result in an error.
GuestSpaceId	String	False	This parameter is used for apps that are in the guest space. Do not add this parameter if the connection property GuestSpaceId is specified in the connection string.

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.
Revision	String	The revision number of the record after updating the status. The revision number will increase by 2, as two operations are performed - running the action and updating the status.

Updates the status of an app record.

Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the table below, indexed parameters are denoted with a '#' character at the end of their names.

Input

Name	Type	Required	Description
AppId	String	True	The App Id.
RecordId#	String	True	The record Id.
Action#	String	True	The name of the action you want to run. If the localization feature has been used to apply multiple translations of the action, specify the name of the action in the language settings of the user that will run the API.
Assignee#	String	False	The next Assignee. Specify the log-in name of the Assignee.
Revision#	String	False	The revision number of the record before updating the status. If the specified revision is not the latest revision, the request will result in an error.
GuestSpaceId	String	False	This parameter is used for apps that are in the guest space. Do not add this parameter if the connection property GuestSpaceId is specified in the connection string.

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.
Id	String	The record Id.
Revision	String	The revision number of the record after updating the status. The revision number will increase by 2, as two operations are preformed - running the action and updating the status.

Updates a Thread of a Space.

Stored Procedure Specific Information

Kintone allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:

EXECUTE UpdateThread ThreadId = 13, Name = 'Test Thread', Body = 'This is for testing'

Input

Name	Type	Required	Description
ThreadId	Integer	True	The Thread ID. The Thread ID can be found in the URL of the Thread.
Name	String	False	The new name of the Thread. Must be between 1 - 128 characters. The name will not be updated if this parameter is ignored. The Thread name of single threaded Spaces cannot be updated.
Body	String	False	The contents of the Thread body.

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

The Cloud models the Kintone USER API as relational Views.

Views

The Cloud 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.

CData Cloud - Kintone Views

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.

Select

The UserCode column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM UserDepartments where UserCode = 'loginname';

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
UserCode	String		The log in name of the User.

Gets information of Groups that a User belongs to.

Select

The UserCode column is required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by this column. By default, the Cloud will process other filters client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM UserGroups where UserCode = 'loginname';

Columns

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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
UserCode	String		The log in name of the User.

Gets information of users.

Select

The Cloud uses the Kintone API to process supported filters. By default, the Cloud will process other filters client-side within the Cloud.

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');

Columns

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

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Kintone:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries, including batch operations::

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Comments table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Comments' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the DownloadFile stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'DownloadFile' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'DownloadFile' AND IncludeResultColumns='True'

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native Kintone procedure.

Pseudo-Columns

Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

Describes the primary and foreign keys.

The following query retrieves the primary key for the Comments table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Comments' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

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.

Authentication

---

Property	Description
AuthScheme	Whether to connect to Kintone with User/Password or APIToken or OAuth.
URL	The Kintone URL. For example: https://SUBDOMAIN_NAME.cybozu.com .
Schema	Specify the Kintone API version to use.
User	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.
BasicAuthUser	The additional username required for domains using basic authentication.
BasicAuthPassword	The additional password required for domains using basic authentication.
AppId	The AppId used along with the APIToken for authentication.
APIToken	The APIToken used for authentication.

OAuth

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

Logging

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

---

Property	Description
AllowSpecialCharacters	Determines whether or not to allow special characters. If true special characters will not be replaced.
CheckForSubtablesIn	A comma-separated list of Kintone apps to retrieve subtables from.
GuestSpaceId	Restrict query results to a guest space.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
NumberMapToDouble	Determines whether or not to change the datatype of number fields from decimal to double.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Kintone.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
SubtableIdAsLong	Specifies whether the Id column in subtables should use the Long data type.
SubtableSeparatorCharacter	The character used for dividing tables from subtables in the format tablename + char + subtable.
TableNameMode	The dynamic table identifier for each AppId.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseCodeForFieldName	Determines whether to use Label or Code for Field Name.
UseCursor	Boolean determining if cursors should be used to retrieve records.
UseSimpleNames	Specifies whether or not simple names should be used for tables and columns.
UseUnitForNumericField	Determines whether to display unit with Field Name.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	Whether to connect to Kintone with User/Password or APIToken or OAuth.
URL	The Kintone URL. For example: https://SUBDOMAIN_NAME.cybozu.com .
Schema	Specify the Kintone API version to use.
User	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.
BasicAuthUser	The additional username required for domains using basic authentication.
BasicAuthPassword	The additional password required for domains using basic authentication.
AppId	The AppId used along with the APIToken for authentication.
APIToken	The APIToken used for authentication.

Whether to connect to Kintone with User/Password or APIToken or OAuth.

Possible Values

Password, APIToken, OAuth

Data Type

string

Default Value

"Password"

Remarks

• Password: Set this to perform Password authentication.
• APIToken: Set this to perform APIToken authentication.
• OAuth: Set this to perform OAuth 2.0 authentication.

The Kintone URL. For example: https://SUBDOMAIN_NAME.cybozu.com .

Data Type

string

Default Value

""

Remarks

The Kintone URL. For example:

https://SUBDOMAIN_NAME.cybozu.com

Specify the Kintone API version to use.

Possible Values

Kintone, CybozuUser

Data Type

string

Default Value

"Kintone"

Remarks

Select from the following to specify which API version of Kintone to use:

• Kintone for Kintone REST API.
• CybozuUser for Kintone USER API.

Specifies the authenticating user's user ID.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Specifies the authenticating user's password.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

The additional username required for domains using basic authentication.

Data Type

string

Default Value

""

Remarks

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.

Data Type

string

Default Value

""

Remarks

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.

Data Type

string

Default Value

""

Remarks

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.

Data Type

string

Default Value

""

Remarks

The APIToken used for authentication.To create an API token. Access the specific app to create the API tokens for and click on the cog wheel. Proceed to App Settings tab > API Token > click on the Generate button, an API token will be generated.

You can also specify multiple comma-seperated APITokens in case of operations involving Lookup fields or Related Record fields.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

• When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
• If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

• This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
• Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

Data Type

string

Default Value

""

Remarks

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.

When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

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.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
AllowSpecialCharacters	Determines whether or not to allow special characters. If true special characters will not be replaced.
CheckForSubtablesIn	A comma-separated list of Kintone apps to retrieve subtables from.
GuestSpaceId	Restrict query results to a guest space.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
NumberMapToDouble	Determines whether or not to change the datatype of number fields from decimal to double.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Kintone.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
SubtableIdAsLong	Specifies whether the Id column in subtables should use the Long data type.
SubtableSeparatorCharacter	The character used for dividing tables from subtables in the format tablename + char + subtable.
TableNameMode	The dynamic table identifier for each AppId.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseCodeForFieldName	Determines whether to use Label or Code for Field Name.
UseCursor	Boolean determining if cursors should be used to retrieve records.
UseSimpleNames	Specifies whether or not simple names should be used for tables and columns.
UseUnitForNumericField	Determines whether to display unit with Field Name.

Determines whether or not to allow special characters. If true special characters will not be replaced.

Data Type

bool

Default Value

false

Remarks

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.

Data Type

string

Default Value

"*"

Remarks

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

Data Type

string

Default Value

""

Remarks

This connection property restricts query results to the specified guest space.

You can find the GuestSpaceId from the Cloud in the SpaceId column of the Apps table. Or, obtain the GuestSpaceId from the URL when you navigate to the created space. For example, in the following URL, the GuestSpaceId would be "3":

https://xlqc1.cybozu.com/k/guest/3/#/space/3/thread/3

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Determines whether or not to change the datatype of number fields from decimal to double.

Data Type

bool

Default Value

false

Remarks

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 the maximum number of records per page the provider returns when requesting data from Kintone.

Data Type

int

Default Value

500

Remarks

When processing a query, instead of requesting all of the queried data at once from Kintone, the Cloud can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Cloud requests per page.

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Cloud to use more memory when executing queries and risks triggering a timeout.

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud 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:

*=*