kintone
kintone連携に関するアクション一覧です。
kintoneGetRecords
概要
kintoneGetRecords は、kintone に登録されているアプリのレコードを一括取得する機能です。 クエリを使用して、取得するレコードの条件や並び順を指定することが可能です。\ クエリの書き方については、以下をご参照ください。
- kintone API のクエリの基本的な書き方について
- クエリに使用できる演算子や関数について
- 現在 kintone アプリのレコード一覧画面で設定している「絞り込み条件」または「絞り込み条件とソート条件」をクエリに変換する方法について
パラメーター
*は、必須パラメーター
| 名前 | 型 | 概要 | 例 |
|---|---|---|---|
| provider* | 文字列 | kintone 連携に必要なプロバイダー ID | kt_y8ni9c3b8b8147410ce2 |
| appId* | 数値 | 取得したいレコードが登録された kintone アプリの ID | 25 |
| fields | 配列 | 取得するレコードに含めるフィールドをフィールドコード^1)の配列で入力。指定しない場合は全てのフィールドが取得されます。 | ["レコード番号", "作成日時", "ドロップダウン"] |
| query | 文字列 | 取得するレコードの条件。指定しない場合は閲覧権限を持つすべてのレコードがID降順で取得される。 | 作成者 in (" USER", "example@example.com") and 作成日時 >= LAST_WEEK() order by 作成日時 desc limit 20 offset 0 |
| useGateway | 真理値 | trueの時、ワークフローに設定したゲートウェイ経由でKintoneサーバーに接続します | true |
| outputFormat | 文字列 | レコードの出力形式を選択することができます。Flat - Kintoneのレコード取得APIからのレスポンスを扱いやすい形式で出力します。Table - Kintoneのレコード取得APIからのレスポンスを二次元配列に変換して出力します。Raw - Kintoneのレコード取得APIのレスポンスをそのままの形式で出力します。 | Flat |
アプリ ID ピッカーについて
アプリ ID ピッカーは最大 100 件までのアプリ ID を表示します。 ピッカーに表示されない値も appId パラメータとして設定することは可能です。
アウトプット
| タイプ | 型 | 概要 | 例 |
|---|---|---|---|
| Array | 配列 | 取得したレコード | ＊使用例を参照 |
使用例
# クエリを実行する
+kintone_get_records_1:
action>: kintoneGetRecords
provider: kintone_2890b93211ca476cd4c9
appId: 25
fields: [ "経費", "経費合計","申請者", "旅費合計", "ステータス", "作成日時" ]
query: '作成者 in ("USER", "example@example.com") and 作成日時 >= LAST_WEEK() order by 作成日時 desc limit 2 offset 0'
useGateway: true
outputFormat: Flat
# [
# {
# "経費": [
# {
# "id": "5",
# "value": {
# "科目": { "type": "DROP_DOWN", "value": null },
# "経費日付": { "type": "DATE", "value": "2022-01-24" },
# "経費領収書": { "type": "CHECK_BOX", "value": [] },
# "経費摘要": { "type": "SINGLE_LINE_TEXT", "value": "" },
# "支払先": { "type": "SINGLE_LINE_TEXT", "value": "" },
# "経費金額": { "type": "NUMBER", "value": "200" }
# }
# }
# ],
# "経費合計": "200",
# "申請者": [{ "code": "example@example.com", "name": "田中 太郎" }],
# "旅費合計": "5000",
# "ステータス": "未処理",
# "作成日時": "2022-01-24T03:26:00Z",
# "$id": "10"
# },
# {
# "経費": [
# {
# "id": "6",
# "value": {
# "科目": { "type": "DROP_DOWN", "value": null },
# "経費日付": { "type": "DATE", "value": "2022-01-23" },
# "経費領収書": { "type": "CHECK_BOX", "value": [] },
# "経費摘要": { "type": "SINGLE_LINE_TEXT", "value": "" },
# "支払先": { "type": "SINGLE_LINE_TEXT", "value": "" },
# "経費金額": { "type": "NUMBER", "value": "100" }
# }
# }
# ],
# "経費合計": "100",
# "申請者": [{ "code": "example@example.com", "name": "田中 太郎" }],
# "旅費合計": "5100",
# "ステータス": "未処理",
# "作成日時": "2022-01-23T02:15:00Z",
# "$id": "9"
# }
# ]
kintoneCreateRecord
概要
kintoneCreateRecord は、kintone のアプリに新たにレコードを登録する機能です。\ 登録するレコードはオブジェクト形式で作成し、各フィールドの値を指定します。\ 入力が必須でないフィールドについて、値を設定しない場合は初期値または空欄として登録されます。 また、存在しないフィールドが指定された場合は無視されます。\ 以下のフィールドは値の登録ができません。
- ルックアップ
- ルックアップ元からコピーされるフィールド
- ステータス
- カテゴリー
- 計算
- 作業者
- テーブル
- 自動計算が設定されている文字列（1行）フィールド
パラメーター
*は、必須パラメーター
| 名前 | 型 | 概要 | 例 |
|---|---|---|---|
| provider* | 文字列 | kintone 連携に必要なプロバイダー ID | kt_y8ni9c3b8b8147410ce2 |
| appId* | 数値 | レコードを登録したい kintone アプリの ID | 25 |
| record | オブジェクト | 登録したいレコードの情報 | ＊使用例を参照 |
| useGateway | 真理値 | trueの時、ワークフローに設定したゲートウェイ経由でKintoneサーバーに接続します | true |
レコードオブジェクトについて
レコードはキーに kintone アプリのフィールドコード、バリューにその値が指定されるオブジェクトで設定します。\ 基本的に値は、文字列または数値で指定してください。\ ユーザーを選択するフィールド（作成者・更新者・ユーザー選択）については、kintone に登録された「ログイン名」を利用して値を指定することが可能です。\
// 例）
{ "経費合計": { "value": 5000 } }
以下のフィールドについては、値を配列形式で指定してください。\
- ユーザー選択
- 組織選択
- グループ選択
- チェックボックス
- 複数選択
// 例）
{
"承認者": { "value": ["example@example.com", "test@example.com"] }
}
添付ファイルのフィールドについては、値を文字列または配列形式で指定してください。\
// 例）
{
"画像": { "value": "+get_file_1" },
"資料": { "value": ["+get_file_2", "+get_file_2"] }
}
アウトプット
| タイプ | 型 | 概要 | 例 |
|---|---|---|---|
| Boolean | 真偽値 | 登録に成功した場合はtrue、失敗した場合はエラーになる | true |
使用例
# レコードを作成する
+kintone_create_record_1:
action>: kintoneCreateRecord
provider: kintone_e2e59120c904a8556217
appId: 25
record:
経費合計:
value: '0'
申請者:
value:
- 'example@example.com'
旅費合計:
value: 5000
useGateway: true
# true
kintoneUpdateRecord
概要
kintoneUpdateRecord は、kintone のアプリ内のレコードを更新する機能です。\ 更新するレコードはオブジェクト形式で作成し、各フィールドの値を指定します。\ 存在しないフィールドが指定された場合は無視されます。\ 以下のフィールドは値の更新ができません。
- ルックアップ
- ルックアップ元からコピーされるフィールド
- ステータス
- カテゴリー
- 計算
- 作業者
- テーブル
- 作成者
- 作成日時
- 更新者
- 更新日時
- 自動計算が設定されている文字列（1行）フィールド
- 本アクションの updateKey パラメータとして指定されたフィールド
パラメーター
* は、必須パラメーター\ ** は、条件付きの必須パラメーター
| 名前 | 型 | 概要 | 例 |
|---|---|---|---|
| provider* | 文字列 | kintone 連携に必要なプロバイダー ID | kt_y8ni9c3b8b8147410ce2 |
| appId* | 数値 | 更新するレコードが登録されている kintone アプリの ID | 25 |
| updateKey** | オブジェクト | 更新したいレコードのフィールド情報 |
{ "field": "申請者", "value": "example@example.com" } |
| recordId** | 数値 / オブジェクト / 文字列 | 更新するレコードの ID か、kintoneGetRecords アクションで取得したレコードのオブジェクトを指定できます。 |
3 |
| record | オブジェクト | 更新するレコードの情報 | ＊使用例を参照 |
| useGateway | 真理値 | trueの時、ワークフローに設定したゲートウェイ経由でKintoneサーバーに接続します | true |
アプリ ID ピッカーについてはこちら\ レコードオブジェクトについてはこちら
アップデートキーについて
アップデートキーは、kintone アプリに登録されたレコードの中から更新したいレコードを特定するために、アプリ内の値の重複が禁止されたフィールドの値を指定するためのパラメータです。\ 指定可能なフィールドは、「値の重複を禁止する」が有効に設定された以下のフィールドです。\ なお、本パラメータで設定されたフィールドは、更新することができないことに注意してください。\
- 文字列（1行）
- 数値
レコード ID について
レコード ID は kintoneGetRecords アクションで取得したレコードの JSON 配列の要素をそのまま利用することが可能です。\ 設定方法は使用例を参照ください。
アウトプット
| タイプ | 型 | 概要 | 例 |
|---|---|---|---|
| Boolean | 真偽値 | 登録に成功した場合はtrue、失敗した場合はエラーになる | true |
使用例
# レコードを一括取得する
+kintone_get_records_1:
action>: kintoneGetRecords
provider: kintone_123abc456def789ghi
appId: 10000
fields: []
query: ''
meta:
display:
provider:
type: chip
label: 'kintone (hoge.cybozu.com)'
icon: kintone
appId:
label: '新しいアプリ'
icon: kintone
type: chip
useGateway: true
# 各要素について繰り返す
+for_each_1:
for_each>:
record: +kintone_get_records_1
_do:
# レコードを1件更新する
+kintone_update_record_1:
action>: kintoneUpdateRecord
provider: kintone_6e2ac7c63324ae58c7c9
appId: 10000
updateKey: ''
recordId: ${record}
record:
担当者:
value:
- 'example@example.com'
meta:
display:
provider:
type: chip
label: 'kintone (hoge.cybozu.com)'
icon: kintone
appId:
label: '新しいアプリ'
icon: kintone
type: chip
useGateway: true
# true
kintoneAddRecordToTable
概要
このアクションはプレビュー版であり、仕様の変更や廃止になる可能性があります。
kintoneAddRecordToTable は、kintone に登録されているアプリのテーブルフィールドにレコードを追加する機能です。 存在しないフィールドが指定された場合は無視されます。
以下のフィールドは値の更新ができません。
- ルックアップ元からコピーされるフィールド
- 計算
- 作成者
- 自動計算が設定されている文字列（1行）フィールド
パラメーター
*は、必須パラメーター
| 名前 | 型 | 概要 | 例 |
|---|---|---|---|
| provider* | 文字列 | kintone 連携に必要なプロバイダー ID | kt_y8ni9c3b8b8147410ce2 |
| appId* | 数値 | 取得したいレコードが登録された kintone アプリの ID | 25 |
| recordId* | 数値 | テーブルフィールドを持ったレコードの ID | 3 |
| tableName* | 文字列 | テーブルフィールドの名前 | テーブル |
| tableRecord | オブジェクト | テーブルフィールドに追加するレコードの情報 | {"文字列_1行":{"value":"hoge"},"チェックボックス":{"value":["sample1","sample2"]}} |
| clearTableRecords | 真偽値 | ONにすると既に入力されているテーブルのレコードを全て消去した後、レコードを追加します | false |
| useGateway | 真理値 | trueの時、ワークフローに設定したゲートウェイ経由でKintoneサーバーに接続します | true |
アプリ ID ピッカーについて
アプリ ID ピッカーは最大 100 件までのアプリ ID を表示します。 ピッカーに表示されない値も appId パラメータとして設定することは可能です。
アウトプット
| タイプ | 型 | 概要 | 例 |
|---|---|---|---|
| Boolean | 真偽値 | 登録に成功した場合はtrue、失敗した場合はエラーになる | true |
使用例
# テーブルにレコードを追加する
+kintone_add_record_to_table_1:
action>: kintoneAddRecordToTable
provider: kintone_a6aaavmr7nwri89h7
appId: 16
recordId: 1
tableName: 'テーブル'
tableRecord:
文字列__1行_:
value: hoge
チェックボックス:
value:
- sample1
- sample2
ラジオボタン:
value: sample2
clearTableRecords: false
private: false
meta:
display:
provider:
type: chip
label: 'kintone (hoge.cybozu.com)'
icon: kintone
appId:
label: '新しいアプリ'
icon: kintone
type: chip
useGateway: true
# true