レコード取得処理
オペレーション名
レコード取得
機能概要
kintoneのレコードを取得します。
データモデル
本コンポーネントのデータモデルはXML型です。
プロパティ
変数の使用については、「変数」を参照してください。
基本設定
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
名前 |
必須 |
使用不可 |
スクリプトキャンバス上での名前を入力します。 |
|
必須設定
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
接続先 |
必須 |
使用不可 |
コネクションリソースを選択します。
|
|
|
検索クエリ |
省略可 |
使用可 |
取得するレコードの絞り込み条件であるクエリ文字列を入力します。 |
注意
[ページングを有効にする]にチェックを入れた場合、クエリ文字列でoffsetまたはlimitを使用しないでください。 |
|
フィールド一覧 |
必須 |
- |
フィールドを指定します。 |
|
|
フィールド一覧/読み取り対象 |
省略可 |
使用不可 |
各フィールドを読み取り対象に含めるかどうかを選択します。
|
注意
1つ以上の列にチェックが入っている必要があります。 |
|
フィールド一覧/フィールド名 |
省略可 |
使用不可 |
フィールド名を表示します。 |
|
|
フィールド一覧/フィールドコード |
省略可 |
使用不可 |
フィールドコードを表示します。 |
|
|
フィールド一覧/フィールドの型 |
省略可 |
使用不可 |
フィールドの型を表示します。 |
|
|
フィールド一覧/サブテーブル |
省略可 |
使用不可 |
フィールドがサブテーブルに含まれる場合にサブテーブルのフィールドコードを表示します。 |
|
> プロパティアクション
|
項目名 |
説明 |
備考 |
|---|---|---|
|
フィールド一覧の更新 |
kintoneアプリからフィールド情報を取得し[フィールド一覧]に設定します。 |
|
レコード取得設定
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
ページングを有効にする |
省略可 |
使用不可 |
ページングを有効にしてAPIの制限件数以上のレコードを取得できるようにするかどうかを選択します。
|
|
|
ページサイズ |
省略可 |
使用可 |
ページングが有効な場合に一度のAPIリクエストで取得するレコード件数を指定します。 |
|
|
ページングの方法 |
省略可 |
使用不可 |
ページングが有効な場合にレコードを取得する方法を指定します。
|
|
添付ファイル
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
添付ファイルをダウンロードする |
省略可 |
使用不可 |
添付ファイルをダウンロードするかを選択します。
|
|
|
添付ファイルの出力方法 |
省略可 |
使用不可 |
添付ファイルの出力方法を選択します。
|
|
|
ダウンロード先ディレクトリー |
必須 |
使用可 |
添付ファイルをダウンロードするディレクトリーを選択または入力します。 [参照]ボタンをクリックするとディレクトリーチューザーが起動し、ディレクトリーの選択ができます。 ダウンロードされた添付ファイルのパスは[ダウンロード先ディレクトリー]/<レコードID>/<フィールドコード>/<ファイルキー>/<添付ファイル名>になります。 |
注意
|
データ処理方式
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
データ処理方式 |
省略可 |
使用不可 |
データ処理方式を選択します。
|
|
コメント
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
コメント |
省略可 |
使用不可 |
このコネクターの簡単な説明を記述することができます。 |
|
大容量データ処理
大容量データ処理に対応しています。
PSPでの使用について
PSPでは使用できません。
使用できるコンポーネント変数
|
コンポーネント変数名 |
説明 |
備考 |
|---|---|---|
|
count |
読み取ったレコードの件数が格納されます。 |
|
|
message_category |
エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。 |
|
|
message_code |
エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。 |
|
|
message_level |
エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。 |
|
|
error_type |
エラー発生時、発生したエラーの種類が格納されます。 |
|
|
error_message |
エラー発生時、発生したエラーのメッセージが格納されます。 |
|
|
error_trace |
エラー発生時、発生したエラーのトレース情報が格納されます。 |
|
ページングが有効な場合、絞り込み結果のレコード件数の合計などによりレコードを取得する方法を使い分ける必要があります。
詳細については、「offset の制限値を考慮したレコード一括取得について 」(https://developer.cybozu.io/hc/ja/articles/360030757312)を参照してください。
|
方法 |
適している利用シナリオ |
考慮点 |
|---|---|---|
|
[offsetを使用する] |
|
|
|
[カーソルAPIを使用する] |
|
|
|
[レコードIDを使用する] |
|
|
上記の内容は、2019年12月8日時点のkintone APIをもとにしています。
今後行われるkintone APIの改修・追加によっては、変更になる場合があります。
メッセージコード、例外メッセージ、制限事項
|
コネクター |
メッセージコード |
例外メッセージ |
制限事項 |
|---|---|---|---|
|
|
|
|
