レコード取得処理

オペレーション名

レコード取得

機能概要

kintoneのレコードを取得します。

データモデル

本コンポーネントのデータモデルはXML型です。

プロパティ

変数の使用については、「変数」を参照してください。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
接続先 必須 使用不可 グローバルリソースを選択します。
グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
  
検索クエリ 省略可 使用可 取得するレコードの絞り込み条件であるクエリ文字列を入力します。
  • クエリ文字列については、kintone API仕様の「「query」パラメータで利用可能な演算子と関数」(https://cybozudev.zendesk.com/hc/ja/articles/202331474-%E3%83%AC%E3%82%B3%E3%83%BC%E3%83%89%E3%81%AE%E5%8F%96%E5%BE%97-GET-#q1)を参照してください。
  • クエリ文字列でoffsetを使用する場合は、[ページングを有効にする]のチェックを外してください。
フィールド一覧 必須 - フィールドを指定します。  
フィールド一覧/読み取り対象 省略可 使用不可 各フィールドを読み取り対象に含めるかどうかを選択します。
  • [チェックあり]:
    読み取り対象に含めます。
  • [チェックなし]:(デフォルト)
    読み取り対象に含めません。
  • 1つ以上の列にチェックが入っている必要があります。
  • チェックを入れた列の列名がMapperのスキーマに表示されます。
  • ヘッダに表示されたチェックボックスを押下することで、一括操作を行うことができます。
フィールド一覧/フィールドコード 省略可 使用不可 フィールドコードを表示します。  
フィールド一覧/フィールドの型 省略可 使用不可 フィールドの型を表示します。  
フィールド一覧/サブテーブル 省略可 使用不可 フィールドがサブテーブルに含まれる場合にサブテーブルのフィールドコードを表示します。  
プロパティアクション
項目名 説明 備考
フィールド一覧の更新 kintoneアプリからフィールド情報を取得し[フィールド一覧]に設定します。
  • kintoneアプリ内に1行以上のレコードが存在している必要があります。
  • kintoneアプリにサブテーブルが存在する場合、サブテーブル内に1行以上のレコードが存在している必要があります。
レコード取得設定
項目名 必須/省略可 変数の使用 説明 備考
ページングを有効にする 省略可 使用不可 ページングを有効にしてAPIの制限件数以上のレコードを取得できるようにするかどうかを選択します。
  • [チェックあり]:(デフォルト)
    APIの制限件数以上のレコードを取得できます。
  • [チェックなし]:
    APIの制限件数以上のレコードは取得できません。
  
添付ファイル
項目名 必須/省略可 変数の使用 説明 備考
添付ファイルをダウンロードする 省略可 使用不可 添付ファイルをダウンロードするかを選択します。
  • [チェックあり]:
    添付ファイルをダウンロードします。
  • [チェックなし]:(デフォルト)
    添付ファイルをダウンロードしません。
  
添付ファイルの出力方法 省略可 使用不可 添付ファイルの出力方法を選択します。
  • [データ(Base64)]:(デフォルト)
    取得した添付ファイルの内容をBase64形式で結果データに出力します。
  • [ファイル]:
    添付ファイルをファイルとして取得します。
  • [添付ファイルをダウンロードする]にチェックを入れた場合、有効になります。
ダウンロード先ディレクトリ 必須 使用可 添付ファイルをダウンロードするディレクトリを選択または入力します。

[参照]ボタンを押下するとディレクトリチューザが起動し、ディレクトリの選択ができます。

ダウンロードされた添付ファイルのパスは[ダウンロード先ディレクトリ]/<レコードID>/<フィールドコード>/<ファイルキー>/<添付ファイル名>になります。
  • [添付ファイルの出力方法]に[ファイル]を選択した場合、有効になります。
  • ファイルパスはDataSpider Cloudファイルシステムの絶対パスで指定してください。
  • パス区切り文字「/」以外のDataSpider Cloudファイルシステムの使用禁止文字は使用できません。
データ処理方式
項目名 必須/省略可 変数の使用 説明 備考
データ処理方式 省略可 使用不可 データ処理方式を選択します。
  • [スクリプトの設定を使用する]:(デフォルト)
    スクリプトプロパティの大容量データ処理の設定をアダプタに使用します。
  • [大容量データ処理を行わない]:
    大容量データ処理を行いません。
  • [大容量データ処理を行う]:
    大容量データ処理を行います。
  
コメント
項目名 必須/省略可 変数の使用 説明 備考
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。		  

スキーマ

入力スキーマ

ありません。

出力スキーマ

本アダプタが使用するスキーマについては、「レコードスキーマ」を参照してください。

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。
読み取りを行うデータのスキーマを指定してください。
詳細については、「スキーマ編集」を参照してください。

大容量データ処理

大容量データ処理に対応しています。

PSPでの使用について

PSPでは使用できません。

使用できるコンポーネント変数

コンポーネント変数名 説明 備考
count 読み取ったレコードの件数が格納されます。
  • デフォルト値はnullです。
message_category エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。
  • デフォルト値はnullです。
message_code エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。
  • デフォルト値はnullです。
message_level エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。
  • デフォルト値はnullです。
error_type エラー発生時、発生したエラーの種類が格納されます。
  • デフォルト値はnullです。
  • エラーの種類は、以下のような形式となります。
    例:「java.io.FileNotFoundException」
  • DataSpider Cloudのバージョンにより、格納される内容が変わる可能性があります。
error_message エラー発生時、発生したエラーのメッセージが格納されます。
  • デフォルト値はnullです。
  • DataSpider Cloudのバージョンにより、格納される内容が変わる可能性があります。
error_trace エラー発生時、発生したエラーのトレース情報が格納されます。
  • デフォルト値はnullです。
  • DataSpider Cloudのバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

主な例外

例外名 原因 対策
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[]		 [接続先]が指定されていません。 [接続先]を指定してください。
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]		 [接続先]で指定したリソース定義が見つかりません。 [接続先]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException
<プロパティ名>が指定されていません。		 [<プロパティ名>]が指定されていません。 [<プロパティ名>]を指定してください。
KintoneResponseStatusException
<ステータスコード> <ステータスコードの内容>
<エラーの内容>		 kintoneでの処理中にエラーが発生しました。 エラーメッセージにしたがって設定を確認してください。
org.apache.http.client.ClientProtocolException [サブドメイン名]が不正です。 [接続先]の[サブドメイン名]を確認してください。