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	Provides full access to the action rules that automate record creation or updates across Kintone apps, allowing administrators to audit or adjust how cross-app workflows operate.
AppPermissions	Manages app-level permissions that control whether users or groups can view, edit, or manage a Kintone app, supporting security reviews and role maintenance.
Comments	Retrieves user comments posted on app records, allowing teams to analyze collaboration activity or export conversation history to external reporting tools.
FieldPermissions	Manages fine-grained access rules for individual fields so administrators can enforce data visibility and edit restrictions at the field level.
FormFields	Allows you to create, update, delete, and query app fields so you can manage an app's data model programmatically.
FormLayout	Exposes the structure of an app's form layout, allowing you to review or update how sections, fields, and elements are arranged for end users.
GeneralNotifications	Controls global notification settings for an app, allowing you to adjust how users are alerted about updates, mentions, or record activity.
GeneralSettings	Provides access to an app's high-level configuration such as name, icon, and operational behavior, supporting version control and configuration audits.
GraphSettings	Manages the charts and analytics defined inside an app so administrators can review or update how data is visualized for users.
PerRecordNotifications	Maintains notification rules tied to individual records, helping you automate alerts based on deadlines, conditions, or workflow changes.
ProcessManagement	Controls the workflow rules that govern how records move through states, allowing administrators to manage process steps, transitions, and restrictions.
RecordPermissions	Defines record-level access policies that determine who can view, modify, delete, or reassign a record, supporting compliance and security reviews.
ReminderNotifications	Controls reminder rules that trigger alerts based on time or conditions, allowing teams to track deadlines or follow-ups more reliably.
SampleApp	Represents the sample Customer Management app from the Sales Support Pack, useful for testing integration scenarios or exploring Kintone functionality.
SampleApp_Table	Provides the detail records that belong to the sample Customer Management app so you can explore relational behavior in the Sales Support Pack.
Space.rsd	Indicates whether the membership of the Space is fixed, preventing members from being added or removed outside of administrator settings.
SpaceMembers	Manages the membership lists of Spaces so you can review or update which users have access to a workspace and its discussions.
Views	Controls the app views that define filtered, sorted, or custom-formatted record lists, supporting administration of user-facing data presentations.

Provides full access to the action rules that automate record creation or updates across Kintone apps, allowing administrators to audit or adjust how cross-app workflows operate.

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		Identifier of the Kintone app whose action settings are being retrieved or updated.
Id [KEY]	String	True		Unique identifier of the action, used to reference or update a specific automation rule.
Index	String	False		Zero-based position of the action within the app's action list, reflecting the order in which actions are displayed.
Name	String	False		Name assigned to the action, typically used to describe its purpose within the app's workflow.
DestApp	String	False		Identifier of the destination app where records are copied when the action is executed.
DestCode	String	False		App code of the destination app, with an empty string returned when no app code is configured in that app's settings.
Mappings	String	False		Array of objects that define field mapping settings for the action, with an empty array returned when no mappings are configured.
Entities	String	False		Array of objects listing the users, groups, or departments that are allowed to use the action, excluding inactive or deleted entities.
Revision	String	False		Revision number of the app settings, allowing you to track configuration versions during updates.

Pseudo-Columns

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

Name	Type	Description
Lang	String	Locale code used to retrieve action settings in a specific language.
IsPreview	Boolean	Indicates whether to retrieve action settings from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.
Actions	String	Value used only when performing an update to supply modified action settings.

Manages app-level permissions that control whether users or groups can view, edit, or manage a Kintone app, supporting security reviews and role maintenance.

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		Identifier of the Kintone app whose permission settings are being retrieved or updated.
EntityType [KEY]	String	False		Type of entity to which the permission applies, such as a user, group, or department.
EntityCode	String	False		Code identifying the entity that receives the permission, used to match users, groups, or departments.
IncludeSubs	Boolean	False		Indicates whether permissions granted to a department also apply to its subordinate departments.
AppEditable	Boolean	False		Specifies whether the entity can manage the app by accessing and modifying its settings.
RecordViewable	Boolean	False		Specifies whether the entity is allowed to view records in the app.
RecordAddable	Boolean	False		Specifies whether the entity is permitted to add new records to the app.
RecordEditable	Boolean	False		Specifies whether the entity can edit existing records in the app.
RecordDeletable	Boolean	False		Specifies whether the entity is allowed to delete records from the app.
RecordImportable	Boolean	False		Specifies whether the entity can import records into the app using file-based operations.
RecordExportable	Boolean	False		Specifies whether the entity can export records from the app for external use or backup.
Revision	String	True		Revision number of the app settings, helping track permission changes over time.

Pseudo-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	Indicates whether to retrieve permission settings from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.
Rights	String	This value is used only when performing an update to supply modified permission settings.

Retrieves user comments posted on app records, allowing teams to analyze collaboration activity or export conversation history to external reporting tools.

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		Identifier of the comment, used to uniquely reference the comment within the app and link it to related actions or metadata.
AppId [KEY]	Integer	False		Identifier of the app that contains the record on which the comment was posted, helping associate discussions with a specific application.
RecordId [KEY]	Integer	False		Identifier of the record that the comment belongs to, allowing you to trace conversations tied to individual data entries.
Text	Longvarchar	False		Full text of the comment, including any line feed characters used to preserve formatting or multi-line input.
CreatorCode	String	True		Login name of the user who created the comment, supporting auditing and user activity tracking.
CreatorName	String	True		Display name of the user who created the comment, used to present readable author information in interfaces or reports.
CreatedAt	Datetime	True		Date and time when the comment was created, providing a chronological reference for discussions and activity history.
MentionsAggregate	String	False		Array containing details about the users mentioned in the comment, enabling notifications and tracking of directed communication.

Manages fine-grained access rules for individual fields so administrators can enforce data visibility and edit restrictions at the field level.

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		Identifier of the Kintone app whose field-level permission settings are being retrieved or updated.
Code [KEY]	String	False		Field code identifying the specific field that has custom permission rules applied.
Entities	String	False		Array listing the users, groups, or departments that receive field-level permissions, ordered by priority to control how permissions are evaluated.
Revision	String	True		Revision number of the app settings, helping track updates to field-permission configurations.

Pseudo-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	Indicates whether to retrieve field-permission details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.
Rights	String	Value used only when performing an update to supply modified field-permission settings.

Allows you to create, update, delete, and query app fields so you can manage an app's data model programmatically.

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		Identifier of the Kintone app whose form-field configuration is being retrieved or updated.
Code [KEY]	String	False		Field code that uniquely identifies the form field within the app's schema.
Enabled	String	True		Indicates whether specific field features are enabled or disabled, helping control how the field behaves in the form.
Label	String	False		Display name shown for the field in the form layout.
NoLabel	Boolean	False		Indicates whether the field's label should be hidden in the form to create a cleaner or more compact layout.
Type	String	False		Field type used in the form, determining the data format and behavior for the field.
Required	String	False		Specifies whether the field must contain a value before a record can be saved.
Unique	String	False		Specifies whether duplicate values are prohibited for the field, enforcing uniqueness across records.
MaxValue	String	False		Maximum number of characters allowed for the field, helping control input length.
MinValue	String	False		Minimum number of characters required for the field to ensure sufficient input.
MaxLength	String	False		Maximum number of digits allowed for numeric fields to control the size of accepted numeric inputs.
MinLength	String	False		Minimum number of digits required for numeric fields to enforce minimal numeric input.
DefaultValue	String	False		Default value applied to the field, returned as an array when the field supports multiple default selections.
DefaultNowValue	String	False		Indicates whether the field should automatically populate with the record creation date.
Options	String	False		Object containing the field's selectable options, such as labels and values used in dropdowns or radio buttons.
Align	String	False		Layout alignment applied to option-based fields, affecting how choices are displayed to users.
Expression	String	False		Formula expression used to calculate the field's value dynamically.
HideExpression	String	False		Indicates whether the field's formula expression should be hidden from users in the form.
Digit	String	False		Indicates whether thousands separators should be used when displaying numeric values.
ThumbnailSize	String	False		Pixel size of image thumbnails shown for fields that store images.
Protocol	String	False		Link-type configuration defining how URLs or link fields behave when opened.
Format	String	False		Display format applied to calculated fields, such as formatting numbers or dates for readability.
DisplayScale	String	False		Number of decimal places to display for numeric fields when rendering values.
Unit	String	False		Currency unit displayed with the field when the field represents financial values.
UnitPosition	String	False		Position of the currency unit relative to the numeric value in the field's display.
Entities	String	False		Array listing the preset users assigned to the field, often used for default assignees or user picker initialization.
ReferenceTable	String	False		Object containing configuration details for a Related Records field, defining how linked records are retrieved and displayed.
LookUp	String	False		Object containing lookup field settings that define how values are pulled from another app's record.
OpenGroup	String	False		Indicates whether the field group should be expanded by default when the form loads.
Fields	String	False		Object containing nested field definitions for table fields, using the same parameters as the Properties structure.
Revision	String	True		Revision number of the app settings, helping track updates to the form configuration.

Pseudo-Columns

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

Name	Type	Description
Lang	String	Locale code used to retrieve form-field data in a specific language.
IsPreview	Boolean	Indicates whether to retrieve form-field settings from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.
Properties	String	Value used only when performing an insert or update to supply modified field definitions.

Exposes the structure of an app's form layout, allowing you to review or update how sections, fields, and elements are arranged for end users.

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		Identifier of the Kintone app whose form layout configuration is being retrieved or updated.
Fields	String	False		List of fields contained in the layout row, representing the elements displayed together in that section of the form.
Type	String	False		Type of layout row, indicating how the row is structured and how its fields are arranged within the form. The allowed values are ROW, SUBTABLE, GROUP.
Code	String	False		Field code of the Table or Group field associated with the row, returned only when the row represents one of these container types.
Revision	String	True		Revision number of the app settings, helping track changes made to the form layout over time.

Pseudo-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	Indicates whether to retrieve form-layout details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.
Layout	String	Value used only when performing an insert or update to supply modified layout definitions.

Controls global notification settings for an app, allowing you to adjust how users are alerted about updates, mentions, or record activity.

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		Identifier of the Kintone app whose general notification settings are being retrieved or updated.
EntityType	String	False		Type of entity that receives the general notifications, such as a user, group, or department.
EntityCode [KEY]	String	False		Code identifying the specific entity configured to receive general notifications.
IncludeSubs	Boolean	False		Indicates whether notification rules assigned to a department should also apply to its subordinate departments, and always returns 'false' unless notifications[].entity.type is set to ORGANIZATION or FIELD_ENTITY for a Department Selection field.
RecordAdded	Boolean	False		Specifies whether the entity should receive a notification whenever a new record is added to the app.
RecordEdited	Boolean	False		Specifies whether the entity should receive a notification when an existing record is edited.
CommentAdded	Boolean	False		Specifies whether the entity should receive a notification when a new comment is posted on a record.
StatusChanged	Boolean	False		Specifies whether the entity should receive a notification when a record's status changes within a workflow.
FileImported	Boolean	False		Specifies whether the entity should receive a notification when data is imported into the app using a file.
NotifyToCommenter	Boolean	False		Specifies whether all commenters on a record should be notified when a new comment is added, reflecting the Send updated comment notifications to all commenters setting.
Revision	String	True		Revision number of the app settings, helping track changes made to notification rules.

Pseudo-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	Indicates whether to retrieve general-notification details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.
Notifications	String	Value used only when performing an update to supply modified general-notification settings.

Provides access to an app's high-level configuration such as name, icon, and operational behavior, supporting version control and configuration audits.

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		Identifier of the Kintone app whose general settings are being retrieved or updated.
IconKey [KEY]	String	False		Key identifier of the app's icon, returned when the app uses one of Kintone's preset icons.
IconType	String	False		Specifies the type of icon used for the app, indicating whether the icon is a PRESET icon or an uploaded FILE.
IconFile	String	False		Object containing data for an uploaded icon file when a custom icon is used for the app.
Name	String	False		Display name of the app as shown in the Kintone interface.
Description	Longvarchar	False		HTML-formatted description of the app, often used to provide context or usage instructions to users.
Theme	String	False		Color theme applied to the app, controlling the visual styling of the app's header and interface accents.
Revision	String	True		Revision number of the app settings, helping track updates made to the app's configuration.
TitleFieldSelectionMode	String	False		Method used to determine which field becomes the record title, allowing either AUTO selection or MANUAL selection by the app designer.
TitleFieldCode	String	False		Field code of the field designated as the record title when MANUAL selection mode is used.
EnableBulkDeletion	Boolean	False		Indicates whether users are allowed to delete multiple records at once using the bulk deletion feature.
EnableComments	Boolean	False		Indicates whether commenting is enabled for the app, allowing users to post comments on records.
EnableDuplicateRecord	Boolean	False		Indicates whether users are allowed to duplicate existing records to create new ones more quickly.
EnableThumbnails	Boolean	False		Indicates whether thumbnails should be displayed for fields that support image previews.
FirstMonthOfFiscalYear	Integer	False		Specifies the first month of the fiscal year for the app, returned as a numeric month value.
NumberPrecisionDecimalPlaces	Integer	False		Specifies the number of decimal places to use when rounding numeric values.
NumberPrecisionDigits	Integer	False		Specifies the total number of digits to allow for numeric values, including integer and fractional parts.
NumberPrecisionRoundingMode	String	False		Rounding mode applied to numeric values, supporting HALF_EVEN, UP, or DOWN.
EnableInlineRecordEditing	Boolean	False		Indicates whether inline editing is enabled in the record list, allowing users to modify fields directly without opening the record.

Pseudo-Columns

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

Name	Type	Description
Lang	String	Locale code used to retrieve general setting values in a specific language.
IsPreview	Boolean	Indicates whether to retrieve general-setting details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.

Manages the charts and analytics defined inside an app so administrators can review or update how data is visualized for users.

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		Identifier of the Kintone app whose graph and reporting settings are being retrieved or updated.
Id [KEY]	String	True		Unique identifier of the graph configuration within the app.
Index	String	False		Zero-based position of the graph in the app's graph list, determining the order in which graphs appear to users.
Name	String	False		Display name of the graph, limited to 64 characters, and returned in the requested language when a lang parameter is provided.
PeriodicReport	String	False		Object containing the graph's periodic report settings, returned as 'null' when no periodic report has ever been configured.
Sorts	String	False		Array of objects defining the Sort by settings that determine how graph data is ordered.
Aggregations	String	False		Function settings used to aggregate field values, such as totals or counts, when generating the graph.
ChartMode	String	False		Display mode applied to the graph, determining how the chart is rendered in the interface.
ChartType	String	False		Chart type selected for the graph, such as bar, line, pie, or other supported visualization formats.
FilterCond	String	False		Record filter condition expressed in query-string format, reflecting the graph's Filter settings.
Groups	String	False		Function settings used for grouping records in the graph, defining how data is categorized during aggregation.
Revision	String	True		Revision number of the app settings, helping track updates made to graph configurations.

Pseudo-Columns

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

Name	Type	Description
Lang	String	Locale code used to retrieve graph-setting values in a specific language.
IsPreview	Boolean	Indicates whether to retrieve graph-setting details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.
Reports	String	Value used only when performing an update to supply modified graph-report settings.

Maintains notification rules tied to individual records, helping you automate alerts based on deadlines, conditions, or workflow changes.

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		Identifier of the Kintone app whose per-record notification settings are being retrieved or updated.
FilterCond	String	False		Record filter condition expressed in query-string format, defining which records trigger the per-record notification.
Title [KEY]	String	False		Subject line used for the notification, corresponding to the Summary field that appears in the Kintone interface.
Targets	String	False		Array of objects listing the users, groups, or departments that receives the per-record notification.
Revision	String	True		Revision number of the app settings, helping track updates made to the notification configuration.

Pseudo-Columns

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

Name	Type	Description
Lang	String	Locale code used to retrieve per-record notification data in a specific language.
IsPreview	Boolean	Indicates whether to retrieve per-record notification details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.
Notifications	String	Value used only when performing an update to supply modified per-record notification settings.

Controls the workflow rules that govern how records move through states, allowing administrators to manage process steps, transitions, and restrictions.

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		Identifier of the Kintone app whose process-management configuration is being retrieved or updated.
Enable	Boolean	False		Indicates whether process management is enabled for the app, controlling whether records progress through defined workflow states.
Actions	String	False		Array containing the app's process-management actions in the same order shown in the user interface, with the value of 'null' returned when process management has never been enabled.
Revision	String	True		Revision number of the app settings, helping track updates made to the process-management configuration.
Name	String	False		Display name of the workflow status associated with the current process-management state.
Index	String	False		Ascending display order of the workflow status, determining its position relative to other statuses.
AssigneeType	String	False		Type of assignee list used for the status, defining how users or groups are selected to handle the workflow step.
AssigneeEntities	String	False		Array listing the assignees configured for the status, returned in the same order presented in the user interface.

Pseudo-Columns

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

Name	Type	Description
Lang	String	Locale code used to retrieve process-management details in a specific language.
IsPreview	Boolean	Indicates whether to retrieve process-management details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.
States	String	Value used only when performing an update to supply modified process-management state definitions.

Defines record-level access policies that determine who can view, modify, delete, or reassign a record, supporting compliance and security reviews.

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		Identifier of the Kintone app whose record-level permission settings are being retrieved or updated.
FilterCond	String	False		Filter condition expressed in query-string format that determines which records the permission rule applies to.
Entities	String	False		Array listing the users, groups, or departments that receive the record-level permissions, ordered by priority to control how permissions are evaluated.
Revision	String	False		Revision number of the app settings, helping track updates to record-permission configurations.

Pseudo-Columns

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

Name	Type	Description
Lang	String	Locale code used to retrieve record-permission details in a specific language.
IsPreview	Boolean	Indicates whether to retrieve record-permission details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.
Rights	String	Value used only when performing an update to supply modified record-permission settings.

Controls reminder rules that trigger alerts based on time or conditions, allowing teams to track deadlines or follow-ups more reliably.

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		Identifier of the Kintone app whose reminder-notification settings are being retrieved or updated.
FilterCond	String	False		Record filter condition expressed in query-string format, defining which records trigger the reminder notification.
Title	String	False		Subject line used for the reminder notification, corresponding to the Summary field shown in the Kintone interface.
TimingCode [KEY]	String	False		Field code of the date or datetime field that determines when the reminder notification should be triggered.
TimingDaysLater	Integer	False		Number of days offset from the value in the timing field, where positive values schedule the reminder after that date and negative values schedule it before that date.
TimingHoursLater	Integer	False		Number of hours offset from the timing field's datetime value, applied after the day offset defined by TimingDaysLater.
TimingTime	String	False		Specific time of day when the reminder notification should be sent, returned when the timing field is a date field or when time-based scheduling is configured.
Targets	String	False		Array of objects listing the users, groups, or departments that receive the reminder notification.
Revision	String	True		Revision number of the app settings, helping track changes to the reminder-notification configuration.
Timezone	String	False		Time zone used to determine when reminder notifications are sent, reflecting the Reminder Time Zone setting and returning null when no reminder configuration exists.

Pseudo-Columns

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

Name	Type	Description
Lang	String	Locale code used to retrieve reminder-notification details in a specific language.
IsPreview	Boolean	Indicates whether to retrieve reminder-notification details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.
Notifications	String	Value used only when performing an update to supply modified reminder-notification settings.

Represents the sample Customer Management app from the Sales Support Pack, useful for testing integration scenarios or exploring Kintone functionality.

Columns

Name	Type	ReadOnly	References	Description
RecordId	Int	True		Identifier of the sample record, used to reference or retrieve the entry within the sample app.
Revision	Int	True		Revision number of the sample record, indicating how many times the entry has been updated.
AppId	Int	True		Identifier of the sample app from which the record originates.
Remarks	String	True		Free-text remarks associated with the sample record, typically used for notes or comments.
UpdaterCode	String	True		Login name of the user who last updated the sample record.
UpdaterName	String	True		Display name of the user who last updated the sample record.
CreatorCode	String	True		Login name of the user who originally created the sample record.
CreatorName	String	True		Display name of the user who originally created the sample record.
PostalCode	String	True		Postal code associated with the customer or location represented in the sample record.
DepartmentName	String	True		Name of the department linked to the customer or contact information in the sample record.
EmailAddress	String	True		Email address of the customer or primary contact stored in the sample record.
PersonInChargeName	String	True		Name of the staff member responsible for managing the customer or case represented in the sample record.
UpdateDateAndTime	Datetime	True		Date and time when the sample record was last updated.
CustomerName	String	True		Name of the customer referenced in the sample record.
Address	String	True		Physical address associated with the customer or location in the sample record.
TEL	String	True		Telephone number associated with the customer or primary contact.

Provides the detail records that belong to the sample Customer Management app so you can explore relational behavior in the Sales Support Pack.

Columns

Name	Type	ReadOnly	References	Description
CustomerManagementId	Int	True		Identifier linking the detail record to its corresponding customer management entry in the sample Sales Support Pack.
Id	Int	True		Identifier of the detail record within the sample app's table.
Revision	Int	True		Revision number of the detail record, indicating how many times the entry has been updated.
AppId	Int	True		Identifier of the sample app that contains this detail table record.
ProjectName	String	True		Name of the project associated with the customer, as represented in the sample data.
Probability	String	True		Estimated probability of winning the project, reflecting the sample sales pipeline workflow.
ExpectedOrderDate	Datetime	True		Expected date when the project may result in an order, based on the sample sales timeline.
TotalCost	Double	True		Projected total cost or value associated with the project in the sample dataset.
SalesRepresentativeAggregate	String	True		Aggregate information about the sales representatives assigned to the project within the sample app.

Indicates whether the membership of the Space is fixed, preventing members from being added or removed outside of administrator settings.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Identifier of the Space, used to reference the workspace throughout the Kintone environment.
Name	String	False		Display name of the Space as shown in the Kintone interface.
DefaultThread	String	False		Identifier of the default thread that was automatically created when the Space was first set up.
IsPrivate	Boolean	False		Indicates whether the Space is private, restricting visibility to explicitly assigned members.
CreatorCode	String	False		Login name of the user who created the Space, returned as an empty string for inactive or deleted users.
CreatorName	String	False		Display name of the user who created the Space, returned as an empty string for inactive or deleted users.
ModifierCode	String	False		Login name of the user who last updated the Space settings, returned as an empty string for inactive or deleted users.
ModifierName	String	False		Display name of the user who last updated the Space settings, returned as an empty string for inactive or deleted users.
MemberCount	String	False		Number of members currently belonging to the Space.
CoverType	String	False		Type of image used for the Space's cover photo, indicating whether it is a preset or an uploaded file.
CoverKey	String	False		Key identifier of the cover photo assigned to the Space.
CoverUrl	String	False		URL pointing to the cover photo used in the Space's header.
Body	String	False		HTML content displayed in the Space body, returned as null when no content is set but may contain preserved tags if content existed previously.
UseMultiThread	Boolean	False		Indicates whether the Space allows multiple discussion threads instead of using a single-thread structure.
IsGuest	Boolean	False		Indicates whether the Space is a Guest Space, which restricts access to designated guest users.
AttachedApps	String	False		List of apps associated with the Space's thread, excluding apps that are not yet published.
ShowAnnouncement	Boolean	False		Indicates whether the Announcement widget is displayed in the Space.
ShowThreadList	Boolean	False		Indicates whether the Threads widget is displayed in the Space.
ShowAppList	Boolean	False		Indicates whether the Apps widget is displayed in the Space.
ShowMemberList	Boolean	False		Indicates whether the People widget, which shows Space members, is displayed.
ShowRelatedLinkList	Boolean	False		Indicates whether the Related Apps and Spaces widget is displayed in the Space.

Pseudo-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	Identifier of the Space template used when creating a new Space, required during Space creation.
Members	String	List of users assigned to the Space, required when creating a new Space and must include at least one Space Administrator. Inactive or deleted users cannot be included.

Manages the membership lists of Spaces so you can review or update which users have access to a workspace and its discussions.

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		Identifier of the Space whose membership details are being retrieved or updated.
EntityCode	String	False		Code identifying the user, group, or department that is a member of the Space.
EntityType	String	False		Type of entity assigned to the Space, such as a user, group, or department.
IsAdmin	Boolean	False		Indicates whether the member has Space Administrator privileges, allowing them to manage Space settings and membership.
IsImplicit	Boolean	False		Indicates whether the member was added implicitly through group or department membership rather than being added individually.
IncludeSubs	Boolean	False		Indicates whether membership granted to a department also applies to its subordinate departments.

Pseudo-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	List of members to assign when creating a new Space, requiring at least one Space Administrator and excluding inactive or deleted users.

Controls the app views that define filtered, sorted, or custom-formatted record lists, supporting administration of user-facing data presentations.

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		Identifier of the view, used to reference the specific view configuration within the app.
AppId	Integer	False		Identifier of the Kintone app that contains the view being retrieved or updated.
Index	String	False		Ascending display order of the view, determining its position relative to other views in the app.
Name	String	False		Display name of the view as presented to users in the Kintone interface.
Title	String	False		Field code used as the title field when displaying calendar views, returned only for calendar-type views.
Type	String	False		Type of view, such as list, calendar, or custom, defining how records are presented to the user. The allowed values are LIST, CALENDAR, CUSTOM.
BuiltinType	String	False		Indicates the type of built-in view being used when the view is not custom.
Date	String	False		Field code used as the date field for calendar views, returned only when the view is configured as a calendar view.
Fields	String	False		List of field codes that determine which fields appear in the view's record list.
FilterCond	String	False		Filter condition expressed as a query string, defining which records appear in the view.
Html	String	False		HTML content used to render a custom view, returned only when the view is defined as a custom layout.
Pager	Boolean	False		Indicates whether pagination is enabled for the view, returned only for custom views.
Device	String	False		Specifies the device contexts where the view is displayed, such as desktop or mobile.
Sort	String	False		Sort order expressed as a query string, defining how records are ordered within the view.
Revision	String	True		Revision number of the app settings, helping track updates made to the view configuration.

Pseudo-Columns

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

Name	Type	Description
Lang	String	Locale code used to retrieve view details in a specific language.
IsPreview	Boolean	Indicates whether to retrieve view details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.
Views	String	Value used only when performing an update to supply modified view settings.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Kintone Views

Name	Description
ActionSettingsEntities	Returns the detailed components that define each automation rule, helping you understand which fields, conditions, and targets are involved in an action's execution.
ActionSettingsMappings	Lists the field-to-field mappings used by automation rules so you can trace exactly how data moves between apps when an action is triggered.
Apps	Returns all apps in the Kintone environment with key metadata required for cataloging, governance, or integration with external systems.
FieldPermissionsEntities	Breaks field-level permissions into their underlying rules to help you understand exactly how visibility and edit rights differ across users and groups.
FormLayoutFields	Returns the individual layout elements used within an app's form, making it easier to analyze field placement, grouping, and user interface design.
PerRecordNotificationsTargets	Returns the list of users and groups who receive record-level notifications, supporting communication audits and troubleshooting.
ProcessManagementActions	Lists the workflow actions available within a process, helping you analyze or document the transition paths defined in an app's workflow.
RecordPermissionsEntities	Breaks record-level permissions into their detailed entities to show how access rules differ for users, groups, and roles.
ReminderNotificationsTargets	Returns the users and groups associated with reminder notifications, helping you verify who receives automated follow-up alerts.

Returns the detailed components that define each automation rule, helping you understand which fields, conditions, and targets are involved in an action's execution.

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		Identifier of the Kintone app whose action-entity assignments are being retrieved.
Id	String		Unique identifier of the action, used to reference or update the specific automation rule.
Code	String		Code of the entity allowed to use the action, with guest users represented by a login name preceded by guest/.
Type	String		Type of entity permitted to use the action, such as a user, group, or department. The allowed values are USER, GROUP, ORGANIZATION.
Revision	String		Revision number of the app settings, helping track configuration changes over time.

Pseudo-Columns

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

Name	Type	Description
Lang	String		Locale code used to retrieve action-entity details in a specific language.
IsPreview	Boolean		Indicates whether to retrieve action-entity details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.

Lists the field-to-field mappings used by automation rules so you can trace exactly how data moves between apps when an action is triggered.

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		Identifier of the Kintone app whose action mapping details are being retrieved.
Id	String		Unique identifier of the action, used to reference or update the specific automation rule.
SrcType	String		Type of source data used by the action's field mapping, indicating whether the action copies from a field or another supported source. The allowed values are FIELD, RECORD_URL.
SrcField	String		Field code of the source field defined in the field-mapping settings, returned only when the actions.{actionname}.mappings[].srcType value is FIELD.
DestField	String		Field code of the destination field that receives the copied value when the action executes.
Revision	String		Revision number of the app settings, helping track configuration changes to mapping definitions.

Pseudo-Columns

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

Name	Type	Description
Lang	String		Locale code used to retrieve mapping details in a specific language.
IsPreview	Boolean		Indicates whether to retrieve mapping details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.

Returns all apps in the Kintone environment with key metadata required for cataloging, governance, or integration with external systems.

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		Identifier of the Kintone app whose details are being retrieved.
Code	String		App code assigned to the app, returned as a blank value when no app code is configured in the app settings.
Name	String		Display name of the app, returned in the user's configured language when localization settings are enabled.
Description	Longvarchar		Text description of the app, returned in the user's configured language when localization settings are enabled.
SpaceId	String		Identifier of the space that contains the app, with the value of 'null' returned when the app is not created inside a space.
ThreadId	String		Identifier of the thread that contains the app when the app is created inside a space, with the value of 'null' returned when the app does not belong to a space or thread.
CreatedAt	Datetime		Date and time when the app was created.
CreatorCode	String		Login name of the user who created the app, with no value returned for inactive or deleted users.
CreatorName	String		Display name of the user who created the app, with no value returned for inactive or deleted users.
ModifiedAt	Datetime		Date and time when the app was last modified.
ModifierCode	String		Login name of the user who last updated the app, with no value returned for inactive or deleted users.
ModifierName	String		Display name of the user who last updated the app, with no value returned for inactive or deleted users.
Alias	String		Alias name defined for the app, which can be made unique by using the connection property TableNameMode=AppId.
ItemUrl	String		Unique URL used to access or reference the app within the Kintone environment.

Breaks field-level permissions into their underlying rules to help you understand exactly how visibility and edit rights differ across users and groups.

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		Identifier of the Kintone app whose field-permission assignments are being examined or updated.
Code [KEY]	String		Field code that identifies the specific app field for which detailed entity-level permissions are defined.
EntityType	String		Type of entity receiving the field permission, such as a user, group, or department, allowing you to understand how access is structured across the organization.
EntityCode	String		Code that uniquely identifies the user, group, or department to which the field permission applies.
Accessibility	String		Permission level granted to the entity, indicating whether the entity can view, edit, or is restricted from interacting with the field. The allowed values are READ, WRITE, NONE.
IncludeSubs	Boolean		Indicates whether field permissions granted to a department should also apply to its subordinate departments, supporting hierarchical access control.

Pseudo-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		Indicates whether to retrieve field-permission details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.

Returns the individual layout elements used within an app's form, making it easier to analyze field placement, grouping, and user interface design.

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		Identifier of the Kintone app whose form-layout field details are being retrieved.
Code	String		Field code that uniquely identifies the field placed within the form layout.
Type	String		Type of field represented in the layout, determining how the element behaves and is rendered in the form.
ElementId	String		Element identifier assigned to a Space field, returned only when the layout element is a Space field.
Label	Longvarchar		Text used as the label for a Label field, returned only when the element represents a Label component.
Width	String		Width of the field in pixels, defining how much horizontal space the element occupies in the layout.
Height	String		Total height of the field in pixels, including the space used by the field name.
InnerHeight	String		Height of the field in pixels excluding the field name, showing the actual input or display area size.

Pseudo-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		Indicates whether to retrieve form-layout field details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.

Returns the list of users and groups who receive record-level notifications, supporting communication audits and troubleshooting.

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		Identifier of the Kintone app whose per-record notification target settings are being retrieved.
Title	String		Subject line of the per-record notification, matching the Summary text used when the notification is sent.
EntityType	String		Type of entity configured to receive the per-record notification, such as a user, group, or department.
EntityCode	String		Code identifying the specific entity that receives the per-record notification.
IncludeSubs	Boolean		Indicates whether notification rules assigned to a department should also apply to its subordinate departments.

Pseudo-Columns

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

Name	Type	Description
Lang	String		Locale code used to retrieve target-setting values in a specific language.
IsPreview	Boolean		Indicates whether to retrieve per-record notification target details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.

Lists the workflow actions available within a process, helping you analyze or document the transition paths defined in an app's workflow.

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		Identifier of the Kintone app whose process-management action settings are being retrieved.
Name	String		Name of the workflow action, representing the transition users can apply to move a record between statuses.
From	String		Name of the current workflow status from which the action can be performed.
To	String		Name of the workflow status that the record is moved to when the action is executed.
FilterCond	String		Condition expressed in query-string format that determines whether the action is available based on record data.

Pseudo-Columns

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

Name	Type	Description
Lang	String		Locale code used to retrieve process-management action details in a specific language.
IsPreview	Boolean		Indicates whether to retrieve process-management action details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.

Breaks record-level permissions into their detailed entities to show how access rules differ for users, groups, and roles.

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		Identifier of the Kintone app whose record-permission entity assignments are being retrieved.
FilterCond	String		Filter condition expressed in query-string format that specifies which records the entity-level permissions apply to.
EntityType	String		Type of entity that receives the record-level permission, such as a user, group, or department.
EntityCode	String		Code identifying the specific entity to which the record-level permission is granted.
Viewable	Boolean		Indicates whether the entity has permission to view records that match the filter condition.
Editable	Boolean		Indicates whether the entity has permission to edit records that match the filter condition.
Deletable	Boolean		Indicates whether the entity has permission to delete records that match the filter condition.
IncludeSubs	Boolean		Indicates whether permissions assigned to a department should also apply to its subordinate departments.

Pseudo-Columns

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

Name	Type	Description
Lang	String		Locale code used to retrieve entity-level record-permission details in a specific language.
IsPreview	Boolean		Indicates whether to retrieve record-permission entity details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.

Returns the users and groups associated with reminder notifications, helping you verify who receives automated follow-up alerts.

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		Identifier of the Kintone app whose reminder-notification target settings are being retrieved.
TimingCode [KEY]	String		Field code of the date or datetime field that determines when the reminder notification is triggered.
EntityType	String		Type of entity configured to receive the reminder notification, such as a user, group, or department.
EntityCode	String		Code identifying the specific entity that receives the reminder notification.
IncludeSubs	Boolean		Indicates whether reminder-notification rules assigned to a department should also apply to its subordinate departments.

Pseudo-Columns

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

Name	Type	Description
Lang	String		Locale code used to retrieve reminder-notification target details in a specific language.
IsPreview	Boolean		Indicates whether to retrieve reminder-notification target details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.

Stored procedures are function-like interfaces that extend the functionality of the 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 the Kintone environment for controlled external access without sending invitations or automatically assigning them to Spaces.
AddGuestsToSpace	Assigns existing guest users to a specific guest Space so administrators can grant workspace-level access where needed.
AddThreadComment	Adds a comment to a discussion thread inside a Space to support team communication and auditability.
AppsDeployStatus	Returns the deployment status for one or more apps so you can track whether recent app updates are live and available to users.
CreateApp	Creates a new Kintone app from a provided configuration, supporting automated provisioning workflows.
DeleteGuests	Removes a guest user from the environment, helping administrators maintain security and revoke external access when needed.
DeployApps	Deploys pending app updates so schema changes, permissions, and settings become active in the production environment.
UpdateAssignees	Updates the user or group assigned to a record, supporting workflow progression or ownership changes.
UpdateStatus	Updates a record's status field to move it through a workflow step or process stage.
UpdateThread	Updates an existing discussion thread inside a Space so teams can maintain current and accurate collaboration history.

Adds guest users to the Kintone environment for controlled external access without sending invitations or automatically assigning them to Spaces.

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	Display name assigned to the guest user, which must contain between 1 and 128 characters.
Code	String	False	Email address used as the guest user's login name, serving as the primary identifier for authentication.
Password	String	False	Alphanumeric password for the guest user's login credentials, required for account creation.
Timezone	String	False	Time zone setting applied to the guest user, used for timestamp display and scheduling behavior.
Locale	String	False	Specifies the language preference for the guest user. Accepted values are 'auto', 'en', 'zh', 'ja'. The default value is 'auto'.
Image	String	False	Profile image for the guest user, provided by specifying the fileKey of an uploaded file.
SurNameReading	String	False	Phonetic reading of the guest user's surname, with a maximum length of 64 characters.
GivenNameReading	String	False	Phonetic reading of the guest user's given name, with a maximum length of 64 characters.
Company	String	False	Company name displayed on the guest user's profile to provide organizational context.
Division	String	False	Department or division name displayed on the guest user's profile.
Phone	String	False	Contact phone number displayed on the guest user's profile.
CallTo	String	False	Skype name associated with the guest user for communication or collaboration purposes.
GuestsAggregate	String	False	Aggregate structure containing one or more guest user definitions for batch processing.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the operation completed successfully by returning a Boolean value.

Assigns existing guest users to a specific guest Space so administrators can grant workspace-level access where needed.

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	Identifier of the guest space to which the specified guest users are added.
Guests	String	True	List of email addresses representing the guest users who should be granted access to the guest space.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the operation completed successfully by returning a Boolean value.

Adds a comment to a discussion thread inside a Space to support team communication and auditability.

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	Identifier of the space where the comment is added.
ThreadId	Integer	True	Identifier of the thread within the space that receives the new comment.
Text	String	False	Content of the comment, supporting line breaks using LF and allowing up to 65,535 characters. This value is required if the Files input is not provided.
Mentions	String	False	Array of mention objects used to notify other Kintone users within the comment.
Files	String	False	Array containing attachment file data, allowing up to five files. This value is required if the Text input is not provided.

Result Set Columns

Name	Type	Description
Id	String	Identifier of the newly created comment.
Success	String	Indicates whether the operation completed successfully by returning a Boolean value.

Returns the deployment status for one or more apps so you can track whether recent app updates are live and available to users.

Input

Name	Type	Required	Description
AppIds	String	True	Specifies one or more app IDs to check, allowing a single value or a comma-separated list of IDs.
GuestSpaceId	String	False	Identifies the guest space that contains the apps, and should be omitted when the connection property GuestSpaceId is already set in the connection string.

Result Set Columns

Name	Type	Description
AppId	String	Returns the ID of the app whose deployment status is being reported.
Status	String	Returns the deployment status of the app, indicating whether recent updates have been applied.

Creates a new Kintone app from a provided configuration, supporting automated provisioning workflows.

Input

Name	Type	Required	Description
Name	String	True	Specifies the name of the new app, which must contain fewer than 64 characters to meet Kintone's naming requirements.
Space	String	False	The Id of the space. Do not specify this if the connection property GuestSpaceId is set in the connection string.
ThreadId	String	False	The Id of the thread. This is required if the Space parameter or the connection property GuestSpaceId is specified.
IsGuestSpace	Boolean	False	Indicates whether the Space parameter refers to a guest space, requiring the value 'true' for guest spaces and 'false' for normal spaces. The default value is false.

Result Set Columns

Name	Type	Description
AppId	String	Returns the identifier of the newly created app.
Revision	String	Returns the revision number assigned to the new app's initial configuration.
Success	String	Indicates whether the operation completed successfully by returning a Boolean value.

Removes a guest user from the environment, helping administrators maintain security and revoke external access when needed.

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	List of email addresses identifying the guest users to delete, allowing up to 100 users to be removed in a single operation.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the operation completed successfully by returning a Boolean value.

Deploys pending app updates so schema changes, permissions, and settings become active in the production environment.

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

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

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

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

Input

Name	Type	Required	Description
AppId#	String	True	Specifies one or more app IDs to deploy, allowing a single value or a comma-separated list of IDs.
Revision#	String	False	Specifies the revision number to deploy. The request fails if the provided revision does not match the latest operational configuration.
Revert	Boolean	False	Indicates whether to cancel pending application-setting changes by setting this value to 'true'. The default value is false.
GuestSpaceId	String	False	Identifies the guest space that contains the apps, and should not be provided when the connection property GuestSpaceId is already set in the connection string.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the operation completed successfully by returning a Boolean value.

Updates the user or group assigned to a record, supporting workflow progression or ownership changes.

Input

Name	Type	Required	Description
AppId	String	True	Identifier of the Kintone app that contains the record whose assignees are updated.
RecordId	String	True	Identifier of the record for which the assignees are being changed.
Assignees	String	True	List of user codes representing the users assigned to the record, allowing up to 100 assignees and assigning none when the list is empty.
Revision	String	False	Revision number of the record before the update, required to prevent conflicts when the record has been modified since it was last retrieved.
GuestSpaceId	String	False	Identifies the guest space that contains the record, and should not be provided when the connection property GuestSpaceId is already set in the connection string.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the operation completed successfully by returning a Boolean value.
Revision	String	Revision number of the record after the update, which increases by two because both running the action and updating the status count as separate operations.

Updates a record's status field to move it through a workflow step or process stage.

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

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

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

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

Input

Name	Type	Required	Description
AppId	String	True	Identifier of the Kintone app that contains the record whose status is updated.
RecordId#	String	True	Identifier of the record that is moved to a new status when the action is executed.
Action#	String	True	Name of the workflow action to run, which must match the action name in the user's language settings when localized action names are in use.
Assignee#	String	False	Login name of the user who becomes the next assignee after the status transition is completed.
Revision#	String	False	Revision number of the record before the status update, required to ensure the record has not been modified since it was last retrieved.
GuestSpaceId	String	False	Identifies the guest space that contains the record, and should not be provided when the connection property GuestSpaceId is already set in the connection string.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the operation completed successfully by returning a Boolean value.
Id	String	Identifier of the record whose status was updated.
Revision	String	Revision number of the record after the update, which increases by two because both running the action and updating the status count as separate operations.

Updates an existing discussion thread inside a Space so teams can maintain current and accurate collaboration history.

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	Identifier of the thread to update, which can be obtained from the thread's URL.
Name	String	False	New display name for the thread, replacing the old name if set. It must have between 1 and 128 characters and cannot be used for Spaces that support only a single thread.
Body	String	False	Updated HTML or text content for the thread body, replacing the existing thread description or discussion header.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the operation completed successfully by returning a Boolean value.

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	Returns the departments a user belongs to along with related job title information, supporting organizational mapping and identity management.
UserGroups	Returns the groups associated with a user so you can understand their access rights and collaborative relationships across the system.
Users	Returns detailed user profile information from the Cybozu directory to support identity synchronization and permission audits.

Returns the departments a user belongs to along with related job title information, supporting organizational mapping and identity management.

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		Unique identifier for the department, used to link department records to related organizational data.
TitleId [KEY]	Long		Unique identifier for the job title, allowing you to associate users or roles with a specific title.
OrganizationCode	String		Code assigned to the department, typically used for internal categorization or external system references.
OrganizationName	String		Primary display name of the department as it appears in the organization's directory.
OrganizationLocalName	String		Localized display name of the department for regions or languages that require a translated label.
OrganizationLocalNameLocale	String		Locale code indicating the language or region associated with the department's localized name.
OrganizationParentCode	String		Code of the department's parent unit to help model the organizational hierarchy. If the value is 'null', it indicates a root-level department.
OrganizationDescription	Longvarchar		Text description that provides additional context about the department's responsibilities or purpose.
TitleCode	String		Internal or external reference code assigned to the job title for classification or system integration.
TitleName	String		Human-readable name of the job title used in employee profiles and organizational charts.
TitleDescription	Longvarchar		Text description explaining the scope, responsibilities, or role of the job title.

Pseudo-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		Login name associated with the user, used to identify the user when querying related records.

Returns the groups associated with a user so you can understand their access rights and collaborative relationships across the system.

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		Unique identifier for the group, used to link the group to membership records and permission assignments.
GroupCode	String		Internal reference code assigned to the group for classification or integration with external systems.
GroupName	String		Display name of the group as it appears in user directories and access management tools.
GroupDescription	Longvarchar		Text description that outlines the purpose, role, or membership characteristics of the group.

Pseudo-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		Login name associated with the user, used to identify which user belongs to the group when querying relationships.

Returns detailed user profile information from the Cybozu directory to support identity synchronization and permission audits.

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		Unique identifier for the user, used to reference the user across related records and organizational structures.
Code	String		Login name associated with the user, used for authentication and identifying the user in queries.
CreatedTime	Datetime		Date and time when the user account was first created, supporting audit and lifecycle tracking.
UpdatedTime	Datetime		Date and time when the user account was last modified, helping track profile updates or administrative changes.
Valid	Boolean		Indicates whether the user's status is active, allowing systems to filter out deactivated or archived accounts.
Name	String		Primary display name of the user as it appears in directories and user-facing applications.
SurName	String		Family name of the user, typically used in formal identification and directory listings.
GivenName	String		First name of the user, representing the personal portion of the user's full name.
SurNameReading	String		Phonetic reading of the user's family name, supporting pronunciation guidance in languages that require it.
GivenNameReading	String		Phonetic reading of the user's first name, helping ensure accurate pronunciation in supported locales.
LocalName	String		Localized version of the user's display name for regions or languages that require translation or adaptation.
LocalNameLocale	String		Locale code indicating the language or region associated with the user's localized display name.
Timezone	String		Identifier of the time zone configured for the user, ensuring correct scheduling and timestamp alignment.
Locale	String		Language preference set for the user, influencing UI display and formatting behavior.
Description	Longvarchar		The user's profile description or About Me text, often used to share background information or role context.
Phone	String		Primary phone number associated with the user for contact or directory purposes.
MobilePhone	String		Mobile phone number of the user, used for direct communication or multi-factor verification.
ExtensionNumber	String		Internal extension assigned to the user for office or system-based telecommunications.
Email	String		Email address of the user, serving as a primary communication channel and identifier.
SkypeID	String		Skype identifier associated with the user for messaging or online collaboration.
Url	String		Profile URL field where the user can include a personal or work-related link.
EmployeeNumber	String		Employee number assigned to the user for internal tracking, payroll, or Human Resources (HR) systems.
BirthDate	Datetime		Birth date of the user, used for administrative records or compliance requirements.
JoinDate	Datetime		Hire date of the user, supporting tenure tracking, HR records, and onboarding workflows.
PrimaryOrganization	Integer		Identifier of the user's primary department. If the value is 'null', there is no designated primary assignment.
SortOrder	Integer		Display order value used to control how the user appears in sorted lists or organizational views.
CustomItemValues	String		List of custom field name and code pairs, representing extended profile attributes defined by the organization.

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.
ThrowsKeyNotFound	Specifies whether or not throws an exception if there is no rows updated.
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.
ThrowsKeyNotFound	Specifies whether or not throws an exception if there is no rows updated.
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:

*=*

Specifies whether the Id column in subtables should use the Long data type.

Data Type

bool

Default Value

false

Remarks

By default, the Id column in subtables is returned as an Integer. Setting SubtableIdAsLong to true changes the type of this column to Long.

This property is useful if your subtables contain a large number of records, where the Integer type might be insufficient to represent all values reliably.