kintone

Author: Cybozu
Version: 0.1.2
Type: tool

Overview

This is a plugin for interacting with kintone apps.
By using this plugin, you can easily access and manage the information stored in your kintone app.

Features

Get Record
Add Record
Update Record
Get Records

Configuration

Authentication

To authenticate, you need API Token of the target kintone app with the necessary permissions depending on the plugin.

For generating the API tokens:

Click the App settings icon (the gear-shaped icon) at the upper right of the View screen.
Select the App settings tab in App settings, then click API token under Customization and integration.
On the API token screen, click Generate.
For the generated API token, select the checkboxes under Permissions for the actions you want to allow.
If necessary, add notes for the API token by clicking the Edit icon for the Notes input field.
You can use this field to enter information useful for managing the API token, such as the purpose of the API token or a contact person.
Click the Save icon (the check mark) to save your notes.
Click Save at the bottom right of the screen.
Click Update app at the upper right of the screen.
On the Update app dialog, click Update app.

Document for generating API tokens

Plugin Descriptions

Get Record

The kintone get single record plugin.
This plugin retrieves a specific record from a kintone app using its REST API.

Parameters:

domain_name (string): required
Please enter the value of your kintone URL.
e.g.
app_id (number): required
Please enter kintone App ID which you want to connect to.
If you want to check the App ID, please open the kintone app record list page and check the URL.
https://[subdomain].cybozu.com/k/[AppID]
api_token (string): required
Please generate an API token from the app settings and enter it here.
record_id (number): required
Please enter Record ID which you want to get record.
If you want to check the Record ID, open the record detail page of the kintone app and check the URL.
https://[subdomain].cybozu.com/k/[AppID]/show#record=[RecordID]

Add Record

The kintone add record plugin.
This plugin creates a new record in a kintone app using its REST API.

Parameters:

domain_name (string): required
Please enter the value of your kintone URL.
e.g.
app_id (number): required
Please enter kintone App ID which you want to connect to.
If you want to check the App ID, please open the kintone app record list page and check the URL.
https://[subdomain].cybozu.com/k/[AppID]
api_token (string): required
Please generate an API token from the app settings and enter it here.
If you want to operate records in Lookup, please enter the API tokens of the related apps, separated by commas.
e.g. *maximum 9 API tokens.
record_data (string): required
Please enter the data you want to send to kintone in JSON format.
The values that can be specified vary depending on the type of field.
e.g.
For more information about field types, see: Field Types.

Update Record

The kintone update record plugin.
This plugin updates an existing record in a kintone app using its REST API.

Parameters:

domain_name (string): required
Please enter the value of your kintone URL.
e.g.
app_id (number): required
Please enter kintone App ID which you want to connect to.
If you want to check the App ID, please open the kintone app record list page and check the URL.
https://[subdomain].cybozu.com/k/[AppID]
api_token (string): required
Please generate an API token from the app settings and enter it here.
If you want to operate records in Lookup, please enter the API tokens of the related apps, separated by commas.
e.g. *maximum 9 API tokens.
record_id (number): optional
Please enter the Record ID of the record to be updated.
Required if Update Key is not specified.
If you want to check the Record ID, open the record detail page of the kintone app and check the URL.
https://[subdomain].cybozu.com/k/[AppID]/show#record=[RecordID]
record_data (string): required
Please enter the data you want to send to kintone in JSON format.
The values that can be specified vary depending on the type of field.
e.g.
For more information about field types, see: Field Types.
update_key (string): optional
Please enter the unique key of the record to be updated.
Required if Record ID is not specified.
The only fields that can be specified are "Single-line Text" or "Number" fields with the "Prohibit duplicate values" setting enabled.
e.g.
revision (number): optional
Please enter the expected revision number.
If the value does not match, an error will occur and the record will not be updated.
If the value is not specified or is , the revision number will not be checked.

Get Records

The kintone get records plugin.
This plugin retrieves multiple records from a kintone app using its REST API.

Parameters:

domain_name (string): required
Please enter the value of your kintone URL.
e.g.
app_id (number): required
Please enter kintone App ID which you want to connect to.
If you want to check the App ID, please open the kintone app record list page and check the URL.
https://[subdomain].cybozu.com/k/[AppID]
api_token (string): required
Please generate an API token from the app settings and enter it here.
If you want to use Related Records for search records by query, please enter the API tokens of the related apps, separated by commas.
e.g. *maximum 9 API tokens.
For more information, refer to here.
fields (string): optional
Please enter the field codes you want to retrieve, separated by commas.
e.g.
query (string): optional
Please enter query here.
e.g.
For query options such as Order By, Offset, and Limit, please enter them in their respective fields, not in this field.
For more information, refer to here.
order_by (string): optional
Please enter sort option here.
e.g.
offset (number): optional
Please enter the number of records you want to skip.
This skips outputting the first number of records.
The maximum is . Default value is .
e.g. If you enter , this skips the first 30 records, and outputs from the 31st record.
limit (number): optional
Please enter the number of records you want to output.
The initial number is records, and the maximum is .
total_count (boolean): required
Please set if you want to include the total count of records that match the query conditions.

3rd Party License and Notice

Details

Support Policy

If you encounter any issues or have questions, please:

Raise an issue on the GitHub Repository
Contact the plugin author

Privacy Policy

Please read the privacy policy.

Disclaimer

This “kintone Plugin” (the "Plugin") is provided solely to facilitate integration between kintone applications and Dify.
Please use the Plugin at your own discretion and responsibility. Cybozu shall not be liable for any consequences arising from such use, nor Cybozu be responsible for any claims made by third parties.
The Plugin is not eligible for support or maintenance services.
Cybozu makes no warranties that the Plugin will meet your requirements, operate without interruption, or that any defects (including but not limited to bugs and structural issues) will be corrected. In addition, any information or advice provided by Cybozu, whether oral or written, shall not constitute a warranty or expand the scope of any existing warranty in any way.