dify-kintone-plugin

Author: r3-yamauchi Version: 0.0.5 Type: tool

Description

これは kintone アプリのレコードを取得するために使用できる Dify プラグインです。

使用時のイメージを ブログ で紹介しています。

Features

• kintoneのドメインとアプリIDを指定してレコードを取得
• kintoneのドメインとアプリIDを指定してレコードを1件新規追加
• kintoneのドメインとアプリIDを指定して複数レコードを一括追加・更新（upsert）
• kintoneからファイルをダウンロード

Prerequisites

• 対象のkintoneアプリを閲覧する権限を持つAPIトークン

APIトークン以外の認証方式に対応していません。 Basic認証や SAML認証にも対応していません。

Usage Examples

1. kintone Query

1. 指定したkintoneアプリのすべてのレコードを取得する

{
  "kintone_domain": "dev-demo.cybozu.com",
  "kintone_app_id": 123,
  "kintone_api_token": "abcdefghijklmnopqrstuvwxyz"
}

2. field1 の値が100以上のレコードのみ取得する

{
  "kintone_domain": "dev-demo.cybozu.com",
  "kintone_app_id": 123,
  "kintone_api_token": "abcdefghijklmnopqrstuvwxyz",
  "query": "field1 >= 100"
}

3. 指定したフィールドの値のみを取得する

{
  "kintone_domain": "dev-demo.cybozu.com",
  "kintone_app_id": 123,
  "kintone_api_token": "abcdefghijklmnopqrstuvwxyz",
  "fields": "field1, field2, field3"
}

2. kintone Add Record

1. レコードを 1件新規追加する

{
  "kintone_domain": "dev-demo.cybozu.com",
  "kintone_app_id": 123,
  "kintone_api_token": "abcdefghijklmnopqrstuvwxyz",
  "record_data": {
    "text_field": {"value": "サンプルテキスト"},
    "number_field": {"value": "100"},
    "date_field": {"value": "2025-03-09"}
  }
}

3. kintone Upsert Records

1. 複数のレコードを一度に追加する

{
  "kintone_domain": "dev-demo.cybozu.com",
  "kintone_app_id": 123,
  "kintone_api_token": "abcdefghijklmnopqrstuvwxyz",
  "records_data": {
    "records": [
      {
        "record": {
          "text_field": {"value": "サンプルテキスト1"},
          "number_field": {"value": "100"},
          "date_field": {"value": "2025-03-09"}
        }
      },
      {
        "record": {
          "text_field": {"value": "サンプルテキスト2"},
          "number_field": {"value": "200"},
          "date_field": {"value": "2025-03-10"}
        }
      }
    ]
  }
}

2. updateKeyを使用して既存のレコードを更新する

{
  "kintone_domain": "dev-demo.cybozu.com",
  "kintone_app_id": 123,
  "kintone_api_token": "abcdefghijklmnopqrstuvwxyz",
  "records_data": {
    "records": [
      {
        "updateKey": {
          "field": "key_field",
          "value": "unique_value_1"
        },
        "record": {
          "text_field": {"value": "更新テキスト1"},
          "number_field": {"value": "150"}
        }
      },
      {
        "updateKey": {
          "field": "key_field",
          "value": "unique_value_2"
        },
        "record": {
          "text_field": {"value": "更新テキスト2"},
          "number_field": {"value": "250"}
        }
      }
    ]
  }
}

4. kintone Download File

1. ファイルキーを指定してkintoneからファイルをダウンロードする

{
  "kintone_domain": "dev-demo.cybozu.com",
  "kintone_api_token": "abcdefghijklmnopqrstuvwxyz",
  "file_key": "20250301010101E3C4F3D8871A4BA28360BA3F798D0455165"
}

ファイルキーの取得方法

ファイルキーを取得するには：

1. kintone_query ツールを使用して添付ファイルフィールドを含むレコードを取得
2. レスポンス内の添付ファイルフィールド値を確認（例："添付ファイル": [{"fileKey": "xxxxxxxx"}]）
3. fileKey の値を、このツールの file_key パラメータとして使用

** 「kintone」はサイボウズ株式会社の登録商標です。

ここに記載している内容は情報提供を目的としており、個別のサポートはできません。 設定内容についてのご質問やご自身の環境で動作しないといったお問い合わせをいただいても対応はできませんので、ご了承ください。