Kintone Connection Details¶
Introduction¶
Connector Version
This documentation is based on version 23.0.8895 of the connector.
Get Started¶
Kintone Version Support
The connector models the Kintone REST APIs as a relational database.
Establish a Connection¶
Connect 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.
Authenticate 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.
Use 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.
Desktop Applications¶
To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.
Get and refresh the OAuth access token:
InitiateOAuth
:GETANDREFRESH
. Used to automatically get and refresh theOAuthAccessToken
.OAuthClientId
: The client ID assigned when you registered your custom OAuth application.OAuthClientSecret
: The client secret that was assigned when you registered your custom OAuth application.CallbackURL
: The redirect URI that was defined when you registered your custom OAuth application.UseCursor
:false
.
When you connect, the connector opens Kintone's OAuth endpoint in your default browser. Log in and grant permissions to the application.
After you grant permissions to the application, the connector completes the OAuth process:
- The connector obtains an access token from Kintone and uses it to request data.
- The OAuth values are saved in the path specified in
OAuthSettingsLocation
. These values persist across connections.
When the access token expires, the connector refreshes it automatically.
Automatic refresh of the OAuth access token:
To have the connector automatically refresh the OAuth access token:
- 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 connector to save the OAuth values, which persist across connections.UseCursor
:false
.
- 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.
- To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
- Set these connection properties:
OAuthClientId
: The Client ID in your custom OAuth application settings.OAuthClientSecret
: The Client Secret in your custom OAuth application settings.
- Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
- 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.
Create a Custom OAuth Application¶
Create 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:
- Log into your Kintone and navigate to the
User & System Administration
page. - Click on
OAuth
underSystem Administration
. - Click on the green
Add OAuth Client button
underSet up Advanced Services
. - Enter in the details of the OAuth client.
- 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.
- If you are making a desktop application, set the Callback URL to
- 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.
Important Notes¶
Configuration Files and Their Paths¶
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features¶
This section details a selection of advanced features of the Kintone connector.
User Defined Views
The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings
checkbox on the connection configuration screen.
Query Processing
The connector offloads as much of the SELECT statement processing as possible to Kintone and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
User Defined Views¶
The Kintone connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
- Create a JSON-formatted configuration file defining the views you want.
- DDL statements.
Define Views Using a Configuration File¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Comments WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Define Views Using DDL Statements¶
The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.
Create a View¶
To create a new view using DDL statements, provide the view name and query as follows:
CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;
If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews
connection property.
Alter a View¶
To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:
ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
The view is then updated in the JSON configuration file.
Drop a View¶
To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.
DROP LOCAL VIEW [MyViewName]
This removes the view from the JSON configuration file. It can no longer be queried.
Schema for User Defined Views¶
User Defined Views are exposed in the UserViews
schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName
property.
Work with User Defined Views¶
For example, a SQL statement with a User Defined View called UserViews.RCustomers
only lists customers in Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
Data Model¶
The connector models the Kintone API as relational Tables, Views, and Stored Procedures.
Tables
Using the connector, 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 connector 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 connector installation folder.
Sub-Tables
In some Kintone apps, the user can add custom fields containing many records. The connector 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 connector models apps in the static Apps view.
Tables¶
The connector models the data in Kintone as a list of tables in a relational database that can be queried using standard SQL statements.
Kintone Connector Tables¶
Name | Description |
---|---|
ActionSettings | Update and Query the available Action Settings in kintone. |
AppPermissions | Update and Query the App Permissions in kintone. |
Comments | Query the available comments in kintone. |
FieldPermissions | Update and Query the available FieldPermissions in kintone. |
FormFields | Create, update, delete, and query the Form Fields in Kintone. |
FormLayout | Update and Query the available Form Layout in kintone. |
GeneralNotifications | Update and Query the available GeneralNotifications in kintone. |
GeneralSettings | Update and Query the General Settings in kintone. |
GraphSettings | Update and Query the available Graph Settings in kintone. |
PerRecordNotifications | Update and Query the available PerRecord Notifications in kintone. |
ProcessManagement | Update and Query the Process Management in kintone. |
RecordPermissions | Update and Query the available RecordPermissions in kintone. |
ReminderNotifications | Update and Query the available Reminder Notifications in kintone. |
Space | Create, Update, Delete and Query the available Space in kintone. |
SpaceMembers | Update and Query the available Space Members in kintone. |
Views | Update and Query the available Views in kintone. |
ActionSettings¶
Update and Query the available Action Settings in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM ActionSettings WHERE AppId = 6
SELECT * FROM ActionSettings WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ActionSettings WHERE AppId = 6 AND IsPreview = false
Update¶
For updating the ActionSettings, provide the Actions as an aggregate. The AppId column is required to update the ActionSettings.
UPDATE ActionSettings SET Actions = '{"Action_Z":{"name":"Action_A","index":"0"}}' WHERE AppId = 6
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AppId | Integer | False | The App ID of the kintone application. | |
Id [KEY] | String | True | The ID of the Action. | |
Index | String | False | The order of the Action, starting from 0. | |
Name | String | False | The name of the Action. | |
DestApp | String | False | The App ID of the copy destination app. | |
DestCode | String | False | The App Code of the copy destination app. An empty string is returned if an App Code is not set in the destination app's settings. | |
Mappings | String | False | An array of objects containing the Field Mappings options. An empty array is returned if the Field Mappings options are not configured. | |
Entities | String | False | An array of objects containing the entities the Action is granted to. This reflects the Available To options. Inactive users and deleted users/departments/groups will not be included in the response. | |
Revision | String | False | The revision number of the App settings. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Lang | String | The localized language to retrieve the data. |
IsPreview | Boolean | By setting this to False, you will be able to retrieve the Action Settings details of the live App. Default value is true. |
Actions | String | Only used for performing Update. |
AppPermissions¶
Update and Query the App Permissions in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM AppPermissions WHERE AppId = 6
SELECT * FROM AppPermissions WHERE AppId = 6 AND IsPreview = false
Update¶
For updating the AppPermissions, provide the Rights as an aggregate. The AppId and IsPreview columns are required to update the AppPermissions.
UPDATE AppPermissions SET Rights = '[{"entity":{"type":"CREATOR"},"appEditable":true,"recordViewable":true,"recordAddable":true,"recordEditable":true,"recordDeletable":true,"recordImportable":true,"recordExportable":true}]' WHERE AppId = 6 AND IsPreview = true
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AppId [KEY] | Integer | False | The App ID of the kintone application. | |
EntityType [KEY] | String | False | The type of the entity the permission is granted to. | |
EntityCode | String | False | The code of the entity the permission is granted to. | |
IncludeSubs | Boolean | False | The permission inheritance settings of the department the permission is granted to. | |
AppEditable | Boolean | False | The App management permission of the entity. Entities with this permission are able to access and edit the App's settings. | |
RecordViewable | Boolean | False | The record view permission of the entity. | |
RecordAddable | Boolean | False | The record add permission of the entity. | |
RecordEditable | Boolean | False | The record edit permission of the entity. | |
RecordDeletable | Boolean | False | The record delete permission of the entity. | |
RecordImportable | Boolean | False | The file import permission of the entity. | |
RecordExportable | Boolean | False | The file export permission of the entity. | |
Revision | String | True | The revision number of the App settings. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IsPreview | Boolean | By setting this to False, you will be able to retrieve the App Permissions details of the live App. Default value is true. |
Rights | String | Only used for performing Update. |
Comments¶
Query the available comments in kintone.
Select¶
The RecordId and AppId columns are required in the WHERE clause. The connector will use the Kintone APIs to filter the results by these columns. The Kintone APIs also support filters on Id. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM Comments WHERE RecordId = 1 AND AppId = 5 AND ID = 1
Insert¶
The AppId and RecordId columns are required in the INSERT statement.
INSERT INTO Comments (AppId, RecordId, Text, MentionsAggregate) VALUES (5, 1, 'To do', '[{"code": "Administrator","type": "USER"}]')
Delete¶
Comments can be deleted by issuing a DELETE statement and specifying the RecordId, AppId, and Id.
DELETE FROM Comments WHERE RecordId = 1 AND AppId = 5 AND ID = 1
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
Id [KEY] | Integer | True | The Comment Id. | |
AppId [KEY] | Integer | False | The App Id. | |
RecordId [KEY] | Integer | False | The Record Id. | |
Text | String | False | The comment including the line feed codes. | |
CreatorCode | String | True | The user code of the comment creator (log-in name). | |
CreatorName | String | True | The user name of the comment creator (display name). | |
CreatedAt | Datetime | True | The created date and time of the comment. | |
MentionsAggregate | String | False | An array including information of mentioned users. |
FieldPermissions¶
Update and Query the available FieldPermissions in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM FieldPermissions WHERE AppId = 6
SELECT * FROM FieldPermissions WHERE AppId = 6 AND IsPreview = false
Update¶
For updating the FieldPermissions, provide the Rights as an aggregate. The AppId and IsPreview columns are required to update the FieldPermissions.
UPDATE FieldPermissions SET Rights = 'Update FieldPermissions set Rights='[{"code":"Updated_by","entities":[{"accessibility":"READ","entity":{"type":"GROUP","code":"everyone"}}]}]' WHERE AppId = 6 AND IsPreview = true
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AppId [KEY] | Integer | False | The App ID of the kintone application. | |
Code [KEY] | String | False | The field code of a field that has permission settings. | |
Entities | String | False | An array listing the entities the permissions are granted to, in order of priority. | |
Revision | String | True | The revision number of the App settings. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IsPreview | Boolean | By setting this to False, you will be able to retrieve the FieldPermissions details of the live App. Default value is true. |
Rights | String | Only used for performing Update. |
FormFields¶
Create, update, delete, and query the Form Fields in Kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
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¶
For updating the FormFields, provide the Properties as an aggregate. The AppId column is required to update the FormFields.
UPDATE FormFields SET Properties = '{"Text__single_line_TT":{"code":"Text__single_line_PT","label":"text","type":"SINGLE_LINE_TEXT"}}' WHERE AppId = 6
Delete¶
You need to specify the comma separated values of Code column that you want to delete. The AppId Column is required to delete the FormFields.
DELETE FROM FormFields WHERE Code = 'Text__single_line_CRUD, Text__single_line_TD' AND AppId = 6
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AppId [KEY] | Integer | False | The App ID of the kintone application. | |
Code [KEY] | String | False | The field code. | |
Enabled | String | True | The on/off settings of features. | |
Label | String | False | The field name. | |
NoLabel | Boolean | False | The Hide field name option. | |
Type | String | False | The field type. | |
Required | String | False | The Required field option. | |
Unique | String | False | The Prohibit duplicate values option. | |
MaxValue | String | False | The maximum number of characters for the field. | |
MinValue | String | False | The minimum number of characters for the field. | |
MaxLength | String | False | The maximum number of digits for the field. | |
MinLength | String | False | The minimum number of digits for the field. | |
DefaultValue | String | False | The default value. An array will be returned for fields that can set multiple default values. | |
DefaultNowValue | String | False | The Default to the record creation date option. | |
Options | String | False | An object including data of the field's options. | |
Align | String | False | The layout of the options. | |
Expression | String | False | The formula expression used in the field. | |
HideExpression | String | False | The Hide formula settings for the field. | |
Digit | String | False | The Use thousands separators option. | |
ThumbnailSize | String | False | The size of the image thumbnail in pixels. | |
Protocol | String | False | The Link type settings for the field. | |
Format | String | False | The display format for fields with calculations. | |
DisplayScale | String | False | The number of decimal places to display for the field. | |
Unit | String | False | The Currency settings of the field. | |
UnitPosition | String | False | The display position of the Currency. | |
Entities | String | False | An array listing the preset users for the field. | |
ReferenceTable | String | False | An object containing the settings of the Related Records field. | |
LookUp | String | False | An object containing the settings of the Lookup field. | |
OpenGroup | String | False | The Show fields in this group option. | |
Fields | String | False | An object containing data of fields in a table. The parameters of this object are the same as the properties parameter. | |
Revision | String | True | The revision number of the App settings. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Lang | String | The localized language to retrieve the data. |
IsPreview | Boolean | By setting this to False, you will be able to retrieve the Form Field details of the live App. Default value is true. |
Properties | String | Only used for performing Insert or Update. |
FormLayout¶
Update and Query the available Form Layout in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM FormLayout WHERE AppId = 6
SELECT * FROM FormLayout WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM FormLayout WHERE AppId = 6 AND IsPreview = false
Update¶
For updating the FormLayout, provide the Layout as an aggregate. All fields in the form must be specified in the aggregate. The AppId column is required to update the FormLayout.
UPDATE FormLayout SET Layout = '[{"type":"ROW","fields":[{"type":"SPACER","code":"Table_0","size":{"width":"200"}}]}]' WHERE AppId = 6
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AppId [KEY] | Integer | False | The App ID of the kintone application. | |
Fields | String | False | A list of fields in the row. | |
Type | String | False | The type of row. The allowed values are ROW, SUBTABLE, GROUP. | |
Code | String | False | The field code of the Table or Group field. This parameter will not be returned for other row types. | |
Revision | String | True | The revision number of the App settings. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IsPreview | Boolean | By setting this to False, you will be able to retrieve the Form Layout details of the live App. Default value is true. |
Layout | String | Only used for performing Insert or Update. |
GeneralNotifications¶
Update and Query the available GeneralNotifications in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM GeneralNotifications WHERE AppId = 6
SELECT * FROM GeneralNotifications WHERE AppId = 6 AND IsPreview = false
Update¶
For updating the GeneralNotifications, provide the Notifications as an aggregate. The AppId column is required to update the GeneralNotifications.
UPDATE GeneralNotifications SET Notifications = '[{"entity":{"type":"FIELD_ENTITY","code":"Updated_by"},"includeSubs":false,"recordAdded":false,"commentAdded":true}],"notifyToCommenter":true' WHERE AppId = 6
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AppId [KEY] | Integer | False | The App ID of the kintone application. | |
EntityType | String | False | The type of the entity the General Notification settings are configured to. | |
EntityCode [KEY] | String | False | The code of the entity the General Notification settings are configured to. | |
IncludeSubs | Boolean | False | The Include affiliated departments setting of the Department. Will always return false unless the notifications[].entity.type is set to ORGANIZATION or FIELD_ENTITY for a Department Selection Field. | |
RecordAdded | Boolean | False | Option to notify the entity when a record is added. | |
RecordEdited | Boolean | False | Option to notify the entity when a record is edited. | |
CommentAdded | Boolean | False | Option to notify the entity when a comment is posted. | |
StatusChanged | Boolean | False | Option to notify the entity when a status is changed. | |
FileImported | Boolean | False | Option to notify the entity when a file is imported. | |
NotifyToCommenter | Boolean | False | Option to notify all commenters of a record when a comment is posted on that record. This reflects the Send updated comment notifications to all commenters checkbox. | |
Revision | String | True | The revision number of the App settings. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IsPreview | Boolean | By setting this to False, you will be able to retrieve the GeneralNotifications details of the live App. Default value is true. |
Notifications | String | Only used for performing Update. |
GeneralSettings¶
Update and Query the General Settings in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM GeneralSettings WHERE AppId = 6
SELECT * FROM GeneralSettings WHERE AppId = 6 AND IsPreview = false
Update¶
You must specify the AppId and IconKey of the GeneralSetting to update.
UPDATE GeneralSettings SET Name = 'UpdatedName', Description = 'Test Description', IconType = 'PRESET', IconKey = 'APP72' WHERE IconKey = 'APP72' AND AppId = 6
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AppId [KEY] | Integer | True | The App ID of the kintone application. | |
IconKey [KEY] | String | False | The key identifier of the icon. Responded, if the preset icons within Kintone are used. | |
IconType | String | False | The icon type: FILE, PRESET. | |
IconFile | String | False | The icon type: FILE, PRESET. | |
Name | String | False | The App name. | |
Description | String | False | The app description in HTML format. | |
Theme | String | False | The color theme. | |
Revision | String | True | The revision number of the App settings. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Lang | String | The localized language to retrieve the data. |
IsPreview | Boolean | By setting this to False, you will be able to retrieve the General Settings details of the live App. Default value is true. |
GraphSettings¶
Update and Query the available Graph Settings in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM GraphSettings WHERE AppId = 6
SELECT * FROM GraphSettings WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM GraphSettings WHERE AppId = 6 AND IsPreview = false
Update¶
For updating the GraphSettings, provide the Reports as an aggregate. The AppId column is required to update the GraphSettings.
UPDATE GraphSettings SET Reports = '{"Graph1":{"chartType":"BAR","chartMode":"PERCENTAGE","name":"Updated_Graph_Name","index":"0","groups":[{"code":"Created_by"}]}}' WHERE AppId = 6
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AppId | Integer | False | The App ID of the kintone application. | |
Id [KEY] | String | True | The ID of the graph. | |
Index | String | False | The order of the graphs, starting from 0. | |
Name | String | False | The name of the graph. The maximum limit is 64 characters. When the lang request parameter is specified, the graph's name in that language will be returned. | |
PeriodicReport | String | False | An objects containing the Periodic Reports (External link) options. If the Generate reports periodically option have never been configured, null will be returned. | |
Sorts | String | False | An array of objects containing the Sort by options. | |
AggregationsType | String | False | The type of the Function option. | |
AggregationsCode | String | False | The field code of the field used in the Function option. | |
ChartMode | String | False | The display mode (External link) of the graph. | |
ChartType | String | False | The chart type (External link) of the graph. | |
FilterCond | String | False | The record's filter condition in query string format that reflects the Filter option. | |
GroupsCode | String | False | The field code of the field used to determine the Group by option. | |
GroupsPer | String | False | The time unit used for the Group by option. | |
Revision | String | True | The revision number of the App settings. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Lang | String | The localized language to retrieve the data. |
IsPreview | Boolean | By setting this to False, you will be able to retrieve the Graph Settings details of the live App. Default value is true. |
Reports | String | Only used for performing Update. |
PerRecordNotifications¶
Update and Query the available PerRecord Notifications in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM PerRecordNotifications WHERE AppId = 6
SELECT * FROM PerRecordNotifications WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM PerRecordNotifications WHERE AppId = 6 AND IsPreview = false
Update¶
For updating the PerRecordNotifications, provide the Notifications as an aggregate. The AppId column is required to update the PerRecordNotifications.
UPDATE PerRecordNotifications SET Notifications = '[{"filterCond":"Record_number = 18","title":"Test Title","targets":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}]' WHERE AppId = 6
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AppId [KEY] | Integer | False | The App ID of the kintone application. | |
FilterCond | String | False | The record's filter condition in query string format. | |
Title [KEY] | String | False | The notification subject that is saved under Summary. | |
Targets | String | False | An array of objects containing the recipients of the Per Record Notification. | |
Revision | String | True | The revision number of the App settings. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Lang | String | The localized language to retrieve the data. |
IsPreview | Boolean | By setting this to False, you will be able to retrieve the PerRecordNotifications details of the live App. Default value is true. |
Notifications | String | Only used for performing Update. |
ProcessManagement¶
Update and Query the Process Management in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM ProcessManagement WHERE AppId = 6
SELECT * FROM ProcessManagement WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ProcessManagement WHERE AppId = 6 AND IsPreview = false
Update¶
For updating the ProcessManagement, provide the States and Actions as an aggregate. The AppId column is required to update the ProcessManagement.
UPDATE ProcessManagement SET Enable = true, States = '{"In progress":{"name":"In progress","index":"1","assignee":{"type":"ONE","entities":[]}},"Ready":{"name":"Ready","index":"3","assignee":{"type":"ONE","entities":[]}},"Completed":{"name":"Completed","index":"2","assignee":{"type":"ONE","entities":[]}},"Not started":{"name":"Not started","index":"0","assignee":{"type":"ONE","entities":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}}}', Actions = '[{"name":"Start","from":"Not started","to":"In progress","filterCond":""},{"name":"Complete","from":"Completed","to":"Completed","filterCond":""}]' WHERE AppId = 6
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AppId [KEY] | Integer | False | The App ID of the kintone application. | |
Enable | Boolean | False | The on/off settings of the process management settings. | |
Actions | String | False | An array containing data of the Actions. They are listed in the same order as in the GUI. Null is returned for Apps that have never enabled the process management settings before. | |
Revision | String | True | The revision number of the App settings. | |
Name | String | False | The status name. | |
Index | String | False | The display order (ascending) of the Status, when listed with the other statuses. | |
AssigneeType | String | False | The Assignee List type of the Status. | |
AssigneeEntities | String | False | An array listing data of the Assignees. They are listed in the same order as in the GUI. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Lang | String | The localized language to retrieve the data. |
IsPreview | Boolean | By setting this to False, you will be able to retrieve the Process Management details of the live App. Default value is true. |
States | String | Only used for performing Update. |
RecordPermissions¶
Update and Query the available RecordPermissions in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM RecordPermissions WHERE AppId = 6
SELECT * FROM RecordPermissions WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM RecordPermissions WHERE AppId = 6 AND IsPreview = false
Update¶
For updating the AppPermissions, provide the Rights as an aggregate. The AppId and IsPreview columns are required to update the RecordPermissions.
UPDATE RecordPermissions SET Rights = '[{"filterCond":"","entities":[{"entity":{"type":"GROUP","code":"everyone"},"viewable":false,"editable":false,"deletable":false,"includeSubs":true}]}]' WHERE AppId = 6 AND IsPreview = true
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AppId [KEY] | Integer | False | The App ID of the kintone application. | |
FilterCond | String | False | The filter condition of the record permission. | |
Entities | String | False | An array listing the entities the permissions are granted to, in order of priority. | |
Revision | String | False | The revision number of the App settings. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Lang | String | The localized language to retrieve the data. |
IsPreview | Boolean | By setting this to False, you will be able to retrieve the RecordPermissions details of the live App. Default value is true. |
Rights | String | Only used for performing Update. |
ReminderNotifications¶
Update and Query the available Reminder Notifications in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM ReminderNotifications WHERE AppId = 6
SELECT * FROM ReminderNotifications WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ReminderNotifications WHERE AppId = 6 AND IsPreview = false
Update¶
For updating the ReminderNotifications, provide the Notifications as an aggregate. The AppId column is required to update the ReminderNotifications.
UPDATE ReminderNotifications SET Notifications = '[{"timing":{"code":"Updated_datetime","daysLater":-2,"hoursLater":-5},"filterCond":"Record_number = 14","title":"Reminder: Tomorrow is the deadline.","targets":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}]' WHERE AppId = 6
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AppId [KEY] | Integer | False | The App ID of the kintone application. | |
FilterCond | String | False | The record's filter condition in query string format. | |
Title | String | False | The notification subject that is saved under Summary. | |
TimingCode [KEY] | String | False | The field code of the field used to determine the Reminder notification's timing. | |
TimingDaysLater | Integer | False | The number of days after the notifications[].timing.code date/datetime when the Reminder notification is sent. A negative value indicates the number of days before the notifications[].timing.code date/datetime. | |
TimingHoursLater | Integer | False | The number of hours after the notifications[].timing.code datetime, shifted by daysLater, when the Reminder notification is sent. | |
TimingTime | String | False | The time when the Reminder notification is sent. The parameter is returned if the notifications[].timing.code parameter is set to a date field or the | |
Targets | String | False | An array of objects containing the recipients of the Reminder Notification. | |
Revision | String | True | The revision number of the App settings. | |
Timezone | String | False | The timezone that determines the Reminder notification's timing. This reflects the Reminder Time Zone dropdown option. If the App's Reminder Notification settings have never been configured, null will be returned. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Lang | String | The localized language to retrieve the data. |
IsPreview | Boolean | By setting this to False, you will be able to retrieve the Reminder Notifications details of the live App. Default value is true. |
Notifications | String | Only used for performing Update. |
Space¶
Create, Update, Delete and Query the available Space in kintone.
Select¶
The ID column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM Space WHERE ID = 7
Insert¶
The SpaceTemplateID, Name, Members columns are required in the INSERT statement.
INSERT INTO Space(SpaceTemplateID, Name, Members) Values(1, 'New_Space', '[{"entity":{"type":"USER","code":"cdataarc.handson@gmail.com"},"isAdmin":true}]')
Update¶
The ID column is required to update the Space.
UPDATE Space SET body='Space Body' WHERE ID = 16
Delete¶
The ID column is required to delete the Space.
DELETE FROM Space WHERE ID = 16
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
Id [KEY] | String | True | The Space ID. | |
Name | String | False | The name of the Space. | |
DefaultThread | String | False | The Thread ID of the default thread that was created when the Space was made. | |
IsPrivate | Boolean | False | The Private settings of the Space. | |
CreatorCode | String | False | The code (log in name) of the creator. An empty string is returned for inactive or deleted users. | |
CreatorName | String | False | The display name of the creator. An empty string is returned for inactive or deleted users. | |
ModifierCode | String | False | The code (log in name) of the updater. An empty string is returned for inactive or deleted users. | |
ModifierName | String | False | The display name of the updater. An empty string is returned for inactive or deleted users. | |
MemberCount | String | False | The number of members of the Space. | |
CoverType | String | False | The image type of the Cover Photo. | |
CoverKey | String | False | The key of the Cover Photo. | |
CoverUrl | String | False | The URL of the Cover Photo. | |
Body | String | False | The HTML of the Space body. Null is returned if the HTML in the body is empty. However, if the body has been set before, the HTML tags may be set even if nothing is displayed on the screen and the string will be returned. | |
UseMultiThread | Boolean | False | The Enable multiple threads setting. | |
IsGuest | Boolean | False | The Guest Space setting. | |
FixedMember | Boolean | False | ||
AttachedApps | String | False | A list of Apps that are in the thread. This does not include Apps that are not live yet. | |
ShowAnnouncement | Boolean | False | The display status for the Announcement widget. | |
ShowThreadList | Boolean | False | The display status for the Threads widget. | |
ShowAppList | Boolean | False | The display status for the Apps widget. | |
ShowMemberList | Boolean | False | The display status for the People widget. | |
ShowRelatedLinkList | Boolean | False | The display status for the Related Apps and Spaces widget. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
SpaceTemplateID | String | The Space Template ID. It is required while creating a new Space. |
Members | String | A list of members of the Space. It is required while creating a new Space. At least one Space Administrator must be specified. Inactive and deleted users cannot be specified. |
SpaceMembers¶
Update and Query the available Space Members in kintone.
Select¶
The ID column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
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":"cdataarc.handson@gmail.com"},"isAdmin":true}]' WHERE ID = 1
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
Id [KEY] | String | True | The Space ID. | |
EntityCode | String | False | The code of the Space member. | |
EntityType | String | False | The entity type of the Space member. | |
IsAdmin | Boolean | False | The Space Admin settings of the Space member. | |
IsImplicit | Boolean | False | If the Space Member is added as a User or not. | |
IncludeSubs | Boolean | False | The Include Affiliated Departments setting of the Department Space Member. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Members | String | A list of members of the Space. It is required while creating a new Space. At least one Space Administrator must be specified. Inactive and deleted users cannot be specified. |
Views¶
Update and Query the available Views in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM Views WHERE AppId = 6
SELECT * FROM Views WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM Views WHERE AppId = 6 AND IsPreview = false
Update¶
For updating the Views, provide the Views as an aggregate. View names that are not stated in the aggregate will be deleted. The AppId column is required to update the Views.
UPDATE VIEWS SET Views = '{"(Assigned to me)":{"index":0,"type":"LIST","name":"(Assigned to me)","filterCond":"Assignee in (LOGINUSER())","sort":"Record_number asc"},"subTableTest2":{"index":1,"type":"CALENDAR","name":"subTableTest","date":"Updated_datetime","filterCond":"","sort":"Record_number asc"}}' WHERE AppId = 6
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
Id [KEY] | String | True | The View ID. | |
AppId | Integer | False | The App ID of the kintone application. | |
Index | String | False | The display order (ascending) of the View, when listed with other views. | |
Name | String | False | The name of the View. | |
Title | String | False | The field code set for the Title Field. Responded for Calendar Views. | |
Type | String | False | The type of View. The allowed values are LIST, CALENDAR, CUSTOM. | |
BuiltinType | String | False | The type of the built-in View. | |
Date | String | False | The field code set for the Date Field. Responded for Calendar Views. | |
Fields | String | False | The list of field codes for the fields displayed in the View. | |
FilterCond | String | False | The filter condition as a query. | |
Html | String | False | The HTML code set for the View. Responded for Custom Views. | |
Pager | Boolean | False | The pagination settings. Responded for Custom Views. | |
Device | String | False | The scope of where the view is displayed. | |
Sort | String | False | The sort order as a query. | |
Revision | String | True | The revision number of the App settings. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Lang | String | The localized language to retrieve the data. |
IsPreview | Boolean | By setting this to False, you will be able to retrieve the Views details of the live App. Default value is true. |
Views | String | Only used for performing Update. |
Views¶
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.
Kintone Connector Views¶
Name | Description |
---|---|
ActionSettingsEntities | Query the available Action Settings Entities in kintone. |
ActionSettingsMappings | Query the available Action Settings Mappings in kintone. |
Apps | Query the available apps in kintone. |
FieldPermissionsEntities | Query the Field Permissions Entities in kintone. |
FormLayoutFields | Query the available Form Layout Fields in kintone. |
PerRecordNotificationsTargets | Query the PerRecord Notifications Targets in kintone. |
ProcessManagementActions | Query the Process Management Actions in kintone. |
RecordPermissionsEntities | Query the available Record Permissions Entities in kintone. |
ReminderNotificationsTargets | Query the available Reminder Notifications Targets in kintone. |
ActionSettingsEntities¶
Query the available Action Settings Entities in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM ActionSettingsEntities WHERE AppId = 6
SELECT * FROM ActionSettingsEntities WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ActionSettingsEntities WHERE AppId = 6 AND IsPreview = false
Columns¶
Name | Type | References | Description |
---|---|---|---|
AppId | Integer | The App ID of the kintone application. | |
Id [KEY] | String | The ID of the Action. | |
Code | String | The code of the entity the Action is granted to. For guest users, the login name is preceded by guest/. | |
Type | String | The type of the entity the Action is granted to. The allowed values are USER, GROUP, ORGANIZATION. | |
Revision | String | The revision number of the App settings. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Lang | String | |
IsPreview | Boolean |
ActionSettingsMappings¶
Query the available Action Settings Mappings in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM ActionSettingsMappings WHERE AppId = 6
SELECT * FROM ActionSettingsMappings WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ActionSettingsMappings WHERE AppId = 6 AND IsPreview = false
Columns¶
Name | Type | References | Description |
---|---|---|---|
AppId | Integer | The App ID of the kintone application. | |
Id [KEY] | String | The ID of the Action. | |
SrcType | String | The type of source data that is to be copied. The allowed values are FIELD, RECORD_URL. | |
SrcField | String | The field code of the field specified in the Field Mappings options as the source. This parameter is returned only if the actions.{actionname}.mappings[].srcType parameter is set to FIELD. | |
DestField | String | The field code of the field specified in the Field Mappings options as the destination. | |
Revision | String | The revision number of the App settings. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Lang | String | |
IsPreview | Boolean |
Apps¶
Query the available apps in kintone.
Select¶
By default, the connector will use the Kintone APIs to process search criteria that refer to the following columns and will process other filters client-side within the connector: the Kintone API supports searches on the AppId, Code, and SpaceId columns. These columns support server-side processing for the = and IN operators while the Name column supports only the LIKE operator. For example, the following query is processed server side:
SELECT * FROM Apps WHERE AppId IN (20, 21, 51, 56) AND Name LIKE '%To Do%'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AppId [KEY] | Integer | The App ID of the kintone application. | |
Code | String | The App Code of the app. This will be blank if an App Code is not set in the settings of the App. | |
Name | String | The name of the App. If Localization settings are used, this column will return the localized name dependant on the language settings of the kintone user using this API. | |
Description | String | The description of the App. If Localization settings are used, this column will return the localized app description dependent on the language settings of the kintone user using this API. | |
SpaceId | String | If the app was created inside a space, this column will return the space Id. If not, this column returns null. | |
ThreadId | String | If the app was created inside a space, this column will return the thread ID of the thread of the space it belongs to. For users who have not altered their User Interface Settings to the classic design, apps will automatically belong to the first thread of the space when the app is made in the space. Users who use the classic design will find that they can create apps that are thread-specific instead of space-specific. If the app was not created in a space, null is returned. | |
CreatedAt | Datetime | The date of when the app was created. | |
CreatorCode | String | The log-in name of the creator. Nothing is returned for inactive users and deleted users. | |
CreatorName | String | The display name of the creator. Nothing is returned for inactive users and deleted users. | |
ModifiedAt | Datetime | The date of when the app was last modified. | |
ModifierCode | String | The log-in name of the last updater. Nothing is returned for inactive users and deleted users. | |
ModifierName | String | The display name of the last updater. Nothing is returned for inactive users and deleted users. | |
Alias | String | The alias name of the App. |
FieldPermissionsEntities¶
Query the Field Permissions Entities in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM FieldPermissionsEntities WHERE AppId = 6
SELECT * FROM FieldPermissionsEntities WHERE AppId = 6 AND IsPreview = false
Columns¶
Name | Type | References | Description |
---|---|---|---|
AppId [KEY] | Integer | The App ID of the kintone application. | |
Code [KEY] | String | The field code of a field that has permission settings. | |
EntityType | String | The type of the entity the permission is granted to. | |
EntityCode | String | The code of the entity the permission is granted to. | |
Accessibility | String | The permission granted to the entity. The allowed values are READ, WRITE, NONE. | |
IncludeSubs | Boolean | The permission inheritance settings of the department the permission is granted to. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IsPreview | Boolean |
FormLayoutFields¶
Query the available Form Layout Fields in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM FormLayoutFields WHERE AppId = 6
SELECT * FROM FormLayoutFields WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM FormLayoutFields WHERE AppId = 6 AND IsPreview = false
Columns¶
Name | Type | References | Description |
---|---|---|---|
AppId | Integer | The App ID of the kintone application. | |
Code | String | The field code. | |
Type | String | The type of field. | |
ElementId | String | The element ID of the Space field. Only returned for Space fields. | |
Label | String | The text set in the Label field. Only returned for Label fields. | |
Width | String | The width of the field in pixels. | |
Height | String | The height of the field in pixels, including the height of the field name. | |
InnerHeight | String | The height of the field in pixels, excluding the height of the field name. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IsPreview | Boolean |
PerRecordNotificationsTargets¶
Query the PerRecord Notifications Targets in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
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 [KEY] | Integer | The App ID of the kintone application. | |
Title [KEY] | String | The notification subject that is saved under Summary. | |
EntityType | String | The type of the entity the Per Record Notification settings are configured to. | |
EntityCode | String | The code of the entity the Per Record Notification settings are configured to. | |
IncludeSubs | Boolean | The Include affiliated departments setting of the Department. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Lang | String | |
IsPreview | Boolean |
ProcessManagementActions¶
Query the Process Management Actions in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM ProcessManagementActions WHERE AppId = 6
SELECT * FROM ProcessManagementActions WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ProcessManagementActions WHERE AppId = 6 AND IsPreview = false
Columns¶
Name | Type | References | Description |
---|---|---|---|
AppId | Integer | The App ID of the kintone application. | |
Name | String | The Action name. | |
From | String | The status before taking action. | |
To | String | The status after taking action. | |
FilterCond | String | The branch criteria of the action. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Lang | String | |
IsPreview | Boolean |
RecordPermissionsEntities¶
Query the available Record Permissions Entities in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
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 [KEY] | Integer | The App ID of the kintone application. | |
FilterCond [KEY] | String | The filter condition of the record permission. | |
EntityType | String | The type of the entity the permission is granted to. | |
EntityCode | String | The code of the entity the permission is granted to. | |
Viewable | Boolean | The view permission of the entity. | |
Editable | Boolean | The edit permission of the entity. | |
Deletable | Boolean | The delete permission of the entity. | |
IncludeSubs | Boolean | The permission inheritance settings of the department the permission is granted to. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Lang | String | |
IsPreview | Boolean |
ReminderNotificationsTargets¶
Query the available Reminder Notifications Targets in kintone.
Select¶
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM ReminderNotificationsTargets WHERE AppId = 6
SELECT * FROM ReminderNotificationsTargets WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ReminderNotificationsTargets WHERE AppId = 6 AND IsPreview = false
Columns¶
Name | Type | References | Description |
---|---|---|---|
AppId [KEY] | Integer | The App ID of the kintone application. | |
TimingCode [KEY] | String | The field code of the field used to determine the Reminder notification's timing. | |
EntityType | String | The type of the entity the Reminder Notification settings are configured to. | |
EntityCode | String | The code of the entity the Reminder Notification settings are configured to. | |
IncludeSubs | Boolean | The Include affiliated departments setting of the Department. The Include affiliated departments setting of the Department. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Lang | String | |
IsPreview | Boolean |
Stored Procedures¶
Stored procedures are function-like interfaces that extend the functionality of the connector 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.
Kintone Connector Stored Procedures¶
Name | Description |
---|---|
AddGuests | Adds Guest users to Kintone. This does not affiliate Guest users with any Guest Spaces, and does not send any invitation emails. To affiliate a Guest user with a Guest Space, use the AddGuestsToSpace Stored Procedure. Only Kintone Administrators can use this API. |
AddGuestsToSpace | Add the Guest users with a Guest Space. Only the Guest Space Administrator can use this API. |
AddThreadComment | Adds a comment to a Thread of a Space. |
AppsDeployStatus | Get app deployment statuses. |
CreateApp | Creates apps. |
DeleteGuests | Deletes a Guest user from Kintone. Only Kintone Administrators can use this API. |
DeployApps | Deploys apps. |
DownloadFile | Downloads files from an attachment field in an app. |
GetOAuthAccessToken | Gets an authentication token from Asana. |
GetOAuthAuthorizationURL | Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL. |
RefreshOAuthAccessToken | Refreshes the OAuth access token used for authentication with Asana. |
UpdateAssignees | Updates assignees. |
UpdateStatus | Updates the status of an app record. |
UpdateThread | Updates a Thread of a Space. |
UploadFile | Uploads a document in kintone. |
AddGuests¶
Adds Guest users to Kintone. This does not affiliate Guest users with any Guest Spaces, and does not send any invitation emails. To affiliate a Guest user with a Guest Space, use the AddGuestsToSpace Stored Procedure. Only Kintone Administrators can use this API.
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', 'jack@gmail.com', '#jack@123', 'America/Los_Angeles')
Insert into GuestsAggregate#TEMP(Name, Code, Password, Timezone) Values('Geeky', 'geeky@gmail.com', '#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":"ax@example.com","password":"#abcd@123","timezone":"America/Los_Angeles","locale":"en","name":"John Doe","company":"Company Name","division":"Sales","callto":"skypecallto"}]'
Input¶
Name | Type | Required | Description |
---|---|---|---|
Name | String | False | The display name of the user. Must be between 1 - 128 characters. |
Code | String | False | The email address (log in name) of the Guest user. |
Password | String | False | The log in password of the Guest user. It must be alphanumeric. |
Timezone | String | False | The timezone of the Guest user. |
Locale | String | False | The language settings of the Guest user. Available values are auto, en, zh, ja. If not provided, auto will be set as default. |
Image | String | False | The profile image of the Guest user. Specify a fileKey of an uploaded file. |
SurNameReading | String | False | The Phonetic Surname settings of the Guest User. The maximum limit is 64 characters. |
GivenNameReading | String | False | The Phonetic Given Name settings of the Guest User. The maximum limit is 64 characters. |
Company | String | False | The Company name to display on the Guest User's profile. |
Division | String | False | The Department name to display on the Guest User's profile. |
Phone | String | False | The Phone number to display on the Guest User's profile. |
CallTo | String | False | The Skype Name of the Guest user. |
GuestsAggregate | String | False | The Guests Aggregate. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
AddGuestsToSpace¶
Add the Guest users with a Guest Space. Only the Guest Space Administrator can use this API.
Stored Procedure Specific Information¶
Kintone allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:
EXECUTE AddGuestsToSpace GuestSpaceId = '6', Guests = '["jackd@gmail.com","yogesh@gmail.com","harshm@gmail.com"]'
Input¶
Name | Type | Required | Description |
---|---|---|---|
GuestSpaceId | String | True | The Guest Space ID. |
Guests | String | True | A list of email addresses of Guest users. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
AddThreadComment¶
Adds a comment to a Thread of a Space.
Stored Procedure Specific Information¶
Kintone allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:
EXECUTE AddThreadComment SpaceId = 8, ThreadId = 8, Text = 'Test Comment'
Input¶
Name | Type | Required | Description |
---|---|---|---|
SpaceId | Integer | True | The ID of the space. |
ThreadId | Integer | True | The ID of the thread. |
Text | String | False | The comment contents. A line break can be specified by LF. The maximum characters of the comment is 65535. Required, if files is not set. |
Mentions | String | False | An array including mentions, that notify other Kintone users. |
Files | String | False | An array including data of attachment files. The maximum number of the files is 5. Required, if text is not set. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Id | String | The comment ID of the created comment. |
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
AppsDeployStatus¶
Get app deployment statuses.
Input¶
Name | Type | Required | Description |
---|---|---|---|
AppIds | String | True | The ID of the app. This can be a list of comma-separated Ids. |
GuestSpaceId | String | False | This parameter is used for apps that are in the guest space. Do not add this parameter if the connection property GuestSpaceId is specified in the connection string. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
AppId | String | The ID of the app. |
Status | String | The status of the app. |
CreateApp¶
Creates apps.
Input¶
Name | Type | Required | Description |
---|---|---|---|
Name | String | True | Specify the name of the application in less than 64 characters. |
Space | String | False | The ID of the space. Do not specify this if the connection property GuestSpaceId is set in the connection string. |
ThreadId | String | False | The ID of the thread. This is required if the Space parameter or the connection property GuestSpaceId is specified. |
IsGuestSpace | Boolean | False | This is a boolean value that indicates whether the Space parameter is a normal space or a guest space. Set this value to true for guest spaces. The default value is false. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
AppId | String | The ID of the app. |
Revision | String | The revision of the app. |
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
DeleteGuests¶
Deletes a Guest user from Kintone. Only Kintone Administrators can use this API.
Stored Procedure Specific Information¶
Kintone allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:
For Deleting the Guests, provide the comma separated values of Guests.
EXECUTE DeleteGuests Guests = '["jackd@gmail.com","harshm@gmail.com"]'
Input¶
Name | Type | Required | Description |
---|---|---|---|
Guests | String | True | A list of email addresses of Guest users. Up to 100 Guests can be deleted. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
DeployApps¶
Deploys apps.
Note
This procedure makes use of indexed parameters.
Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.
Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:
EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
In the table below, indexed parameters are denoted with a #
character at the end of their names.
Input¶
Name | Type | Required | Description |
---|---|---|---|
AppId# | String | True | The App Id. This can be a list of comma-separated Ids. |
Revision# | String | False | Specify the revision of the setting that reflects the operational environment. If the specified revision is not up to date, the request will fail. |
Revert | Boolean | False | If you want to cancel the change to the application settings, set this to true. The default value is false. |
GuestSpaceId | String | False | This parameter is used for apps that are in the guest space. Do not add this parameter if the connection property GuestSpaceid is specified in the connection string. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
DownloadFile¶
Downloads files from an attachment field in an app.
Input¶
Name | Type | Required | Description |
---|---|---|---|
FileKey | String | True | The ID of the file. |
LocalPath | String | False | The local path to save the file to. |
FileName | String | False | The file name to save the files to. |
GuestSpaceId | String | False | This parameter is used for documents that are in the guest space. Do not add this parameter if the connection property GuestSpaceId is specified in the connection string. |
Encoding | String | False | The FileData input encoding type. The allowed values are NONE, BASE64. The default value is BASE64. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
FileData | String | Returns File data, if the LocalPath or FileStream input is empty. |
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
GetOAuthAccessToken¶
Gets an authentication token from Asana.
Input¶
Name | Type | Required | Description |
---|---|---|---|
AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app. The allowed values are APP, WEB. The default value is APP. |
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Asana app settings. Only needed when the Authmode parameter is Web. |
Verifier | String | False | The verifier returned from Asana after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
Scope | String | False | A space separated list of scopes limiting an application's access to a user's account. The default value is k:app_record:read k:app_record:write k:app_settings:read k:app_settings:write k:file:read k:file:write. |
State | String | False | Encodes state of the app, which will be returned verbatim in the response and can be used to match the response up to a given request. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The access token used for communication with Asana. |
OAuthRefreshToken | String | The OAuth refresh token. This is the same as the access token in the case of Asana. |
ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
GetOAuthAuthorizationURL¶
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.
Input¶
Name | Type | Required | Description |
---|---|---|---|
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the Asana app settings. |
State | String | False | Encodes state of the app, which will be returned verbatim in the response and can be used to match the response up to a given request. |
Scope | String | False | A space separated list of scopes limiting an application's access to a user's account. The default value is k:app_record:read k:app_record:write k:app_settings:read k:app_settings:write k:file:read k:file:write. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
RefreshOAuthAccessToken¶
Refreshes the OAuth access token used for authentication with Asana.
Input¶
Name | Type | Required | Description |
---|---|---|---|
OAuthRefreshToken | String | True | Set this to the token value that expired. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The authentication token returned from Asana. This can be used in subsequent calls to other operations for this particular service. |
OAuthRefreshToken | String | This is the same as the access token. |
ExpiresIn | String | The remaining lifetime on the access token. |
UpdateAssignees¶
Updates assignees.
Input¶
Name | Type | Required | Description |
---|---|---|---|
AppId | String | True | The App Id. |
RecordId | String | True | The record Id. |
Assignees | String | True | The user codes of the assignees. If empty, no users will be assigned. The maximum number of assignees is 100. |
Revision | String | False | The revision number of the record before updating the assignees. If the specified revision is not the latest revision, the request will result in an error. |
GuestSpaceId | String | False | This parameter is used for apps that are in the guest space. Do not add this parameter if the connection property GuestSpaceId is specified in the connection string. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
Revision | String | The revision number of the record after updating the status. The revision number will increase by 2, as two operations are performed - running the action and updating the status. |
UpdateStatus¶
Updates the status of an app record.
Note
This procedure makes use of indexed parameters.
Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.
Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:
EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
In the table below, indexed parameters are denoted with a #
character at the end of their names.
Input¶
Name | Type | Required | Description |
---|---|---|---|
AppId | String | True | The App Id. |
RecordId# | String | True | The record Id. |
Action# | String | True | The name of the action you want to run. If the localization feature has been used to apply multiple translations of the action, specify the name of the action in the language settings of the user that will run the API. |
Assignee# | String | False | The next Assignee. Specify the log-in name of the Assignee. |
Revision# | String | False | The revision number of the record before updating the status. If the specified revision is not the latest revision, the request will result in an error. |
GuestSpaceId | String | False | This parameter is used for apps that are in the guest space. Do not add this parameter if the connection property GuestSpaceId is specified in the connection string. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
Id | String | The record Id. |
Revision | String | The revision number of the record after updating the status. The revision number will increase by 2, as two operations are preformed - running the action and updating the status. |
UpdateThread¶
Updates a Thread of a Space.
Stored Procedure Specific Information¶
Kintone allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:
EXECUTE UpdateThread ThreadId = 13, Name = 'Test Thread', Body = 'This is for testing'
Input¶
Name | Type | Required | Description |
---|---|---|---|
ThreadId | Integer | True | The Thread ID. The Thread ID can be found in the URL of the Thread. |
Name | String | False | The new name of the Thread. Must be between 1 - 128 characters. The name will not be updated if this parameter is ignored. The Thread name of single threaded Spaces cannot be updated. |
Body | String | False | The contents of the Thread body. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
UploadFile¶
Uploads a document in kintone.
Input¶
Name | Type | Required | Description |
---|---|---|---|
FullPath | String | False | The full path to the document to upload. A value for this field is required when FileData is not specified. |
FileData | String | False | If the FullPath input is empty, Please enter BASE64 encoded FileData. |
FileName | String | False | The name you would like to give the document. If none is specified, the file name specified in the FullPath input will be used. |
ContentType | String | False | Content type of the file. |
GuestSpaceId | String | False | This parameter is used for documents that are in the guest space. Do not add this parameter if the connection property GuestSpaceId is specified in the connection string. |
AttachToApp | String | False | This parameter is of boolean type and it default to false. It is used for attaching the file to an attachment field of an app. |
UploadedFileKey | String | False | The ID of the uploaded file. This is required when AttachToApp set to true and Content or FileData or FullPath is not given. |
AppId | String | False | The Kintone App Id. This is required when AttachToApp set to true. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
FileKey | String | The ID of the uploaded file. |
Success | String | Whether or not the operation was successful. |
Id | String | The Record ID of the uploaded file. Returns when filtering the request with attach parameter. |
Revision | String | The revision number of the record after updating the status. The revision number will increase by 2, as two operations are preformed - running the action and updating the status. Returns when filtering the request with attach parameter. |
System Tables¶
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 connector 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.
sys_catalogs¶
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. |
sys_schemas¶
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. |
sys_tables¶
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. |
sys_tablecolumns¶
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. |
sys_procedures¶
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. |
sys_procedureparameters¶
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
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. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time 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. |
sys_keycolumns¶
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. |
sys_foreignkeys¶
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. |
sys_primarykeys¶
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. |
sys_indexes¶
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. |
sys_connection_props¶
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:kintone:config:
This connection string enables you to query this table without a valid connection.
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. |
sys_sqlinfo¶
Describes the SELECT query processing that the connector can offload to the data source.
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 |
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 Data Sync version needed to access this driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | The 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. |
sys_identity¶
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. |
sys_information¶
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 Sync required to use this connector. |
DataSyncCategory | String | The category of Sync functionality (e.g., Source, Destination). |
Advanced Configurations Properties¶
The advanced configurations 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. Click the links for further details.
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 . |
User | The Kintone user account used to authenticate. |
Password | The password used to authenticate the user. |
BasicAuthUser | The additional username required for domains using basic authentication. |
BasicAuthPassword | The additional password required for domains using basic authentication. |
AppId | The AppId used along with the APIToken for authentication. |
APIToken | The APIToken used for authentication. |
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
Property | Description |
---|---|
SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
SSLClientCertPassword | The password for the TLS/SSL client certificate. |
SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Property | Description |
---|---|
AllowSpecialCharacters | Determines whether or not to allow special characters. If true special characters will not be replaced. |
CheckForSubtablesIn | A comma-separated list of Kintone apps to retrieve subtables from. |
GuestSpaceId | Restrict query results to a guest space. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
NumberMapToDouble | Determines whether or not to change the datatype of number fields from decimal to double. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Kintone. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
SubtableSeparatorCharacter | The character used for dividing tables from subtables in the format tablename + char + subtable. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseCodeForFieldName | Determines whether to use Label or Code for Field Name. |
UseCursor | Boolean determining if cursors should be used to retrieve records. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
UseUnitForNumericField | Determines whether to display unit with Field Name. |
Authentication¶
This section provides a complete list of authentication properties you can configure.
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 . |
User | The Kintone user account used to authenticate. |
Password | The password used to authenticate the user. |
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. |
AuthScheme¶
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.
URL¶
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
User¶
The Kintone user account used to authenticate.
Data Type¶
string
Default Value¶
""
Remarks¶
Together with Password, this field is used to authenticate against the Kintone server.
Password¶
The password used to authenticate the user.
Data Type¶
string
Default Value¶
""
Remarks¶
The User and Password
are together used to authenticate with the server.
BasicAuthUser¶
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.
BasicAuthPassword¶
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.
AppId¶
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.
APIToken¶
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.
OAuth¶
This section provides a complete list of OAuth properties you can configure.
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
InitiateOAuth¶
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Possible Values¶
OFF
, GETANDREFRESH
, REFRESH
Data Type¶
string
Default Value¶
OFF
Remarks¶
The following options are available:
OFF
: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.GETANDREFRESH
: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.REFRESH
: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.
OAuthClientId¶
The client ID assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId
value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
OAuthClientSecret¶
The client secret assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret
property.
OAuthAccessToken¶
The access token for connecting using OAuth.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthAccessToken
property is used to connect using OAuth. The OAuthAccessToken
is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
OAuthSettingsLocation¶
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'
.
Data Type¶
string
Default Value¶
%APPDATA%\Kintone Data Provider\OAuthSettings.txt
Remarks¶
When InitiateOAuth is set to GETANDREFRESH
or REFRESH
, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.
Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://'
followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props
system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.
The default location is "%APPDATA%\Kintone Data Provider\OAuthSettings.txt" with %APPDATA%
set to the user's configuration directory. The default values are
- Windows: "
register://%DSN
" - Unix: "%AppData%..."
- Mac: "%AppData%..."
where DSN is the name of the current DSN used in the open connection.
The following table lists the value of %APPDATA%
by OS:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
CallbackURL¶
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Data Type¶
string
Default Value¶
""
Remarks¶
During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.
OAuthVerifier¶
The verifier code returned from the OAuth authorization URL.
Data Type¶
string
Default Value¶
""
Remarks¶
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
Authentication on Headless Machines¶
See to obtain the OAuthVerifier
value.
Set OAuthSettingsLocation along with OAuthVerifier
. When you connect, the connector exchanges the OAuthVerifier
for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier
from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
OAuthRefreshToken¶
The OAuth refresh token for the corresponding OAuth access token.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthRefreshToken
property is used to refresh the OAuthAccessToken when using OAuth authentication.
OAuthExpiresIn¶
The lifetime in seconds of the OAuth AccessToken.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
OAuthTokenTimestamp¶
The Unix epoch timestamp in milliseconds when the current Access Token was created.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
SSL¶
This section provides a complete list of SSL properties you can configure.
Property | Description |
---|---|
SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
SSLClientCertPassword | The password for the TLS/SSL client certificate. |
SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
SSLClientCert¶
The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
Data Type¶
string
Default Value¶
""
Remarks¶
The name of the certificate store for the client certificate.
The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert
. If the store is password protected, specify the password in SSLClientCertPassword.
SSLClientCert
is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert
has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
Property | Description |
---|---|
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).
SSLClientCertType¶
The type of key store containing the TLS/SSL client certificate.
Possible Values¶
USER
, MACHINE
, PFXFILE
, PFXBLOB
, JKSFILE
, JKSBLOB
, PEMKEY_FILE
, PEMKEY_BLOB
, PUBLIC_KEY_FILE
, PUBLIC_KEY_BLOB
, SSHPUBLIC_KEY_FILE
, SSHPUBLIC_KEY_BLOB
, P7BFILE
, PPKFILE
, XMLFILE
, XMLBLOB
Data Type¶
string
Default Value¶
USER
Remarks¶
This property can take one of the following values:
Property | Description |
---|---|
USER - default | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java. |
MACHINE | For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java. |
PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java. |
JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java. |
PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
PPKFILE | The certificate store is the name of a file that contains a PuTTY Private Key (PPK). |
XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
SSLClientCertPassword¶
The password for the TLS/SSL client certificate.
Data Type¶
string
Default Value¶
""
Remarks¶
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.
SSLClientCertSubject¶
The subject of the TLS/SSL client certificate.
Data Type¶
string
Default Value¶
*
Remarks¶
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, E=support@company.com". The common fields and their meanings are shown below.
Field | Meaning |
---|---|
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Schema¶
This section provides a complete list of schema properties you can configure.
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Location¶
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type¶
string
Default Value¶
%APPDATA%\Kintone Data Provider\Schema
Remarks¶
The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location
property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\Kintone Data Provider\Schema" with %APPDATA%
being set to the user's configuration directory:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
BrowsableSchemas¶
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Tables¶
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Views¶
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Miscellaneous¶
This section provides a complete list of miscellaneous properties you can configure.
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 | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
NumberMapToDouble | Determines whether or not to change the datatype of number fields from decimal to double. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Kintone. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
SubtableSeparatorCharacter | The character used for dividing tables from subtables in the format tablename + char + subtable. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseCodeForFieldName | Determines whether to use Label or Code for Field Name. |
UseCursor | Boolean determining if cursors should be used to retrieve records. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
UseUnitForNumericField | Determines whether to display unit with Field Name. |
AllowSpecialCharacters¶
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.
CheckForSubtablesIn¶
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 connector 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.
GuestSpaceId¶
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 connector 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
MaxRows¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Data Type¶
int
Default Value¶
-1
Remarks¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
NumberMapToDouble¶
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.
Other¶
These hidden properties are used only in specific use cases.
Data Type¶
string
Default Value¶
""
Remarks¶
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
Integration and Formatting¶
Property | Description |
---|---|
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Pagesize¶
The maximum number of results to return per page from Kintone.
Data Type¶
int
Default Value¶
500
Remarks¶
The Pagesize
property affects the maximum number of results to return per page from Kintone. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.
PseudoColumns¶
This property indicates whether or not to include pseudo columns as columns to the table.
Data Type¶
string
Default Value¶
""
Remarks¶
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
SubtableSeparatorCharacter¶
The character used for dividing tables from subtables in the format tablename + char + subtable.
Data Type¶
string
Default Value¶
_
Remarks¶
If an app has a subtable, it is represented as a separate table. Its name will be the AppName + SubtableSeparatorCharacter + SubtableName. Use this property to set a custom character as the separator and easily identify subtables from apps. This property allows you to set different special characters in the subtable's name without breaking your app's naming conventions.
Timeout¶
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type¶
int
Default Value¶
60
Remarks¶
If Timeout
= 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout
expires and the operation is not yet complete, the connector throws an exception.
UseCodeForFieldName¶
Determines whether to use Label or Code for Field Name.
Data Type¶
bool
Default Value¶
false
Remarks¶
If true, Code is used for Field Name.
UseCursor¶
Boolean determining if cursors should be used to retrieve records.
Data Type¶
bool
Default Value¶
true
Remarks¶
Boolean determining if cursors should be used to retrieve records.
UserDefinedViews¶
A filepath pointing to the JSON configuration file containing your custom views.
Data Type¶
string
Default Value¶
""
Remarks¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Comments WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
Note that the specified path is not embedded in quotation marks.
UseSimpleNames¶
Boolean determining if simple names should be used for tables and columns.
Data Type¶
bool
Default Value¶
false
Remarks¶
Kintone tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames
makes the connector easier to use with traditional database tools.
Setting UseSimpleNames
to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.
UseUnitForNumericField¶
Determines whether to display unit with Field Name.
Data Type¶
bool
Default Value¶
true
Remarks¶
If set to false, Unit will not be displayed with Field Name.