kintoneGet - kintoneからの入力

kintoneからレコードを取得します。
kintoneビルダーを使って、kintoneのアプリ一覧やフィールド定義を取得します。詳細については下記トピック「kintoneビルダーの使い方」を参照してください。

■ストリーム情報

入力フォーマットすべて
接続数無制限
説明 入力ストリームは使用せず、すべて無視します。
出力フォーマットRecord
説明 指定したアプリから取得したレコードを、出力ストリームのフィールド定義に従ってレコード形式で出力します。サブテーブルフィールドの値はJSON形式の文字列として出力されます。

■コンポーネントプロパティ

名前プロパティ型マッピング説明
コネクション名connection- 接続先のkintoneを指定します。コネクションペインまたは管理コンソールにて作成されたkintone接続名を選択します。
アプリIDint　　　出力 アプリIDを指定します。
クエリーstring入力＆出力 取得するレコードを絞り込むための条件となるクエリー文字列を指定します。
このプロパティのフォーマットについてはkintoneのAPIヘルプレコードの一括取得（クエリで条件を指定）を参照してください。
ソートキーstring入力＆出力 指定したフィールドコードでレコードを出力する順番をソートします。
ソート順choice入力＆出力 レコードのソート順を指定します。ソートキーが指定されていない場合は使用されません。
昇順 [asc] - レコードを昇順で並べます。
降順 [desc] - レコードを降順で並べます。
リミットint入力＆出力 指定した数だけレコードを取得します。
オフセットint入力＆出力 指定した数だけ出力するレコードをスキップして出力されます。30を指定した場合、レコード先頭から30レコードは出力されず、31番目のレコードから出力されます。
ループを開始loopProcess- 結果をまとめて出力するか、ループして出力するかを選択します。
はい [true] - ループの起点となって1レコードずつストリームに出力します。
いいえ [false] - すべてのレコードをまとめてストリームに出力します。
レコードが無い場合エラーboolean- 結果のレコード件数が0件だった場合にエラーを発生させるかどうかを選択します。
はい [true] - エラーを発生させます。
いいえ [false] - 空のストリームを出力します。
API制限件数int- kintone APIで一度に取得できるレコードの上限値を指定します。この値はkintone APIで定義されているため、制限を超えた値を指定するとエラーが発生します。

■ループ処理

ループを開始が「はい」の場合、 このコンポーネントがループの起点となって結果セットのレコードを1レコードずつ出力します。

■トランザクション処理

コミット何もしません。
ロールバック何もしません。

■エラー処理

タイプパラ
メータ		エラー処理フロー
へのストリーム		エラー
コード		説明
汎用 なし コンポーネントの入力ストリーム1フィールドの値の型変換に失敗した場合。
レコードが無い なし コンポーネントの入力ストリーム2レコードが0件の場合。
APIエラー なし コンポーネントの入力ストリーム201APIの実行でエラーコードを受け取った場合。

■制限事項

■フローサービスのフィールド定義とkintoneのフィールドへのデータ型の関係について

複数値をもつフィールドを取得するには

複数値をもつkintoneのフィールド（CHECK_BOX、MULTI_SELECT、FILE、USER_SELECT）から値を取得するには、フィールドの型をStringにする必要があります。
String型で定義すると、kintoneフィールドが持つ複数の値を「,」(カンマ)区切りでつないだ文字列として取得することができます。

■kintoneビルダーの使い方

kintoneビルダーは、プロパティとストリームを設定するための専用ツールです。kintoneビルダーを使うと、簡単な操作で以下のようなことができます。

●kintoneビルダーを起動する

以下のいずれかの操作でkintoneビルダーを起動します。

●kintoneビルダーの画面

●コネクションを作成する

(1)の接続先プルダウンリストから「新規kintoneコネクション」を選択します。 「新規コネクション作成」ダイアログが表示されるので、接続先の情報を入力して「保存」をクリックします。

●コネクションを編集する

(1)の接続先プルダウンリストから編集するコネクションを選択して、「編集」をクリックします。 コネクションダイアログが表示されるので、編集を行い「保存」をクリックします。

●コネクションを指定する

(1)の接続先プルダウンリストから使用するコネクションを選択します。(2)に指定した接続先のアプリの一覧が表示されます。

●読み込むフィールドを指定する

(2)のアプリ一覧からアプリを選択すると(3)に選択したアプリのフィールド一覧が表示されます。 フィールド一覧でフィールド名の左にあるチェックボックスをオンにします。指定したフィールドを取り消すには、チェックボックスをオフにします。

●読み込み条件を指定する

(3)のフィールド一覧でフィールドをクリックし、右クリックして表示されるメニューから「条件の追加」を選択します。 「条件の編集」ダイアログが表示されるので、条件を入力して「保存」をクリックします。 (4)に指定した条件が追加されます。

読み込み条件を編集する

(4)の条件一覧で編集する条件をクリックし、右クリックして表示されるメニューから「編集」を選択します。 「条件の編集」ダイアログが表示されるので、編集を行い「保存」をクリックします。 (4)の編集した条件が更新されます。

読み込み条件を削除する

(4)の条件一覧で削除する条件をクリックし、右クリックして表示されるメニューから「削除」を選択します。 (4)から指定した条件が削除されます。

●レコードの並び替え

レコードを昇順または降順にソートして読み込むには、ソートキーとソート順を指定します。以下の2つの方法があります。

  1. (3)のフィールド一覧でフィールドをクリックし、右クリックして表示されるメニューから「ソートキーに設定」をクリックします。
  2. (6)のソートキープルダウンリストからフィールドを選択します。

ソートキーを指定後、(6)の「昇順」「降順」プルダウンリストからソート順を選択します。

●リミットを指定する

(6)のリミットフィールドに取得するレコードの件数を入力します。

●オフセットを指定する

(6)のオフセットフィールドにオフセット値を入力します。

●自動生成するリクエストパラメーター表示のオプション

(5)の表示については、(6)でオプションを指定することができます。

(5)のリクエストパラメーターの編集について

kintoneビルダーを使って指定したフィールドの選択、条件などのことをモデルといいます。 「同期」チェックボックスがオンの場合、(3)～(4)のモデルと(5)のリクエストパラメーターが同期して自動生成された状態です。 自動生成したリクエストパラメーターを(5)で直接編集することができます。 この場合、モデルを操作すると直接編集したリクエストパラメーターが同期しないように、自動的に「同期」チェックボックスがオフになります。 直接編集をリセットした場合や再度操作したモデルからリクエストパラメーターを自動生成する場合、「同期」チェックボックスをオンにします。

オプション

●リクエストパラメーターを使用してレコードの取得APIをテスト実行する

リクエストパラメーターを使用して実際にレコードの取得APIをテスト実行するには、(5)の画面下部右側にある「テスト実行」をクリックします。

正常終了の場合、「テスト結果」ダイアログボックスに実行結果のJSON文字列が表示されます。異常終了の場合、エラーメッセージが表示されます。

●注意事項

テストでは、kintone APIで定義されいる一度に取得できるレコードの上限値を超えるレコードは取得することができません。