kintoneSubtablePut - kintoneのサブテーブルへの出力
kintoneのサブテーブルに対してレコードの登録・更新を行います。
kintoneビルダーを使って、kintoneのアプリ一覧やフィールド定義を取得します。詳細については下記トピック「kintoneビルダーの使い方」を参照してください。
■ストリーム情報
| 入力 | フォーマット | Record |
|---|---|---|
| 接続数 | 1 | |
| 説明 | 入力ストリームのフィールド定義を専用の設定画面で行います。 このフィールド定義は直前に連結したマッパーの出力ストリームのフィールド定義にコピーされ、そこに対して値のマッピングを行います。 そのため、このコンポーネントに連結できるコンポーネントはマッパーのみとなっています。 | |
| 出力 | フォーマット | Record |
| 説明 | 入力ストリームをそのまま出力します。 |
■コンポーネントプロパティ
| 名前 | プロパティ型 | マッピング | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| コネクション名 | connection | - | 接続先のkintoneを指定します。コネクションペインまたは管理コンソールにて作成されたkintone接続名を選択します。 | ||||||||||||
| アプリID | int | 入力＆出力 |
アプリIDを指定します。
kintoneビルダーでアプリを選択することで自動的に入力されます。 この値が空の場合、kintoneコネクションの接続設定で認証方法が「APIトークン認証」の場合であれば接続設定で指定したアプリID(複数指定した場合は1番目に指定したもの)が使用されます。 それ以外の場合は必ず指定する必要があります。 |
||||||||||||
| レコード番号 | string | 入力＆出力 |
処理の対象とするサブテーブルの親のレコードのレコード番号を指定します。
レコード番号はkintoneGetコンポーネントで取得することができます。 |
||||||||||||
| サブテーブル名 | string | 出力 | サブテーブル名を指定します。 | ||||||||||||
| 実行する処理 | choice | - |
実行する更新操作を指定します。
|
||||||||||||
| 入力 | category | - | 入力ストリームのフィールド定義を行います。実行する処理が「更新」の場合、kintoneビルダーでテーブルのキーとなるカラムの「キー」項目をチェックします。 |
■ループ処理
なし。
■トランザクション処理
| コミット | 何もしません。 |
|---|---|
| ロールバック | 何もしません。 |
■エラー処理
| タイプ | パラメーター | エラー処理フロー
へのストリーム | エラー
コード | 説明 |
|---|---|---|---|---|
| 汎用 | なし | コンポーネントの入力ストリーム | 1 | 不正なレコード番号が指定された場合。 |
| 2 | 親レコードが見つからなかった場合。 | |||
| APIエラー | なし | コンポーネントの入力ストリーム | 201 | APIの実行でエラーコードを受け取った場合。 |
■制限事項
-
次のフィールド型については特定の値をキーにした更新はできません。
MULTI_LINE_TEXT, RICH_TEXT -
次のフィールド型については空の値をキーにした更新はできません。
FILE, GROUP_SELECT, MULTI_LINE_TEXT, ORGANIZATION_SELECT, RICH_TEXT
■kintone APIリクエスト回数
kintoneSubtablePutコンポーネントのkintone APIリスエスト回数は以下のようになります。
| API | HTTPメソッド | 使用回数 | 説明 |
|---|---|---|---|
| app/form/fields.json | GET | 1回 | フィールド一覧の取得。 |
| records.json | GET | 1回 | レコードの取得。 |
| records.json | PUT | 1回 | レコードの更新。 |
※kintone APIは、kintoneビルダー使用時にも使用されます。
■kintoneビルダーの使い方
kintoneビルダーは、プロパティとストリームを設定するための専用ツールです。kintoneビルダーを使うと、簡単な操作で以下のようなことができます。
- kintoneから取得したアプリ一覧からレコードの登録・更新を行うアプリ、サブテーブル、フィールドを指定
●kintoneビルダーを起動する
以下のいずれかの操作でkintoneビルダーを起動します。
- kintoneSubtablePutコンポーネントをダブルクリック
- kintoneSubtablePutコンポーネントを右クリックして表示されるメニューから「kintoneビルダー」をクリック
●コネクションの選択
コネクション名 が設定されていない場合、kintoneビルダー起動時にコネクションダイアログが表示されます。
新規にコネクションを作成する場合は「新規コネクション」を選択してください。
既存のコネクションを使用する場合は「名前」のプルダウンリストより使用するコネクション名を選択してください。選択したコネクションを使用してkintoneに接続します。
●新規コネクションの作成
「新規コネクション」を選択した場合「コネクションの作成」ダイアログが表示されますので、作成するコネクション名を入力し「OK」ボタンをクリックしてください。
コネクションのプロパティ入力するダイアログが表示されますので、コネクションの各プロパティを設定し「保存」ボタンをクリックしてください。
注意
この時点で新規コネクションが保存されます。作成したコネクションでkintoneに接続します。
kintoneへの接続が成功すると以下のようなダイアログが表示されます。
●kintoneビルダーの画面
- (1)画面上部：接続先と実行する処理を表示する領域
- (2)画面左：アプリ一覧を表示する領域
- (3)画面中央：サブテーブル一覧を表示する領域
- (4)画面右：サブテーブルのフィールド一覧を表示する領域
●コネクションを指定する
(1)の接続先プルダウンリストから使用するコネクションを選択します。(2)に指定した接続先のアプリの一覧が表示されます。
●実行する処理を指定する
(1)の実行する処理プルダウンリストから実行する処理を選択します。
●登録または更新を行うフィールドを指定する
(2)のアプリ一覧からアプリを選択すると(3)に選択したアプリのサブテーブル一覧が表示されます。 (3)のサブテーブル一覧からサブテーブルを選択すると(4)に選択したサブテーブルのフィールド一覧が表示されます。 フィールド一覧でフィールド名の左にあるチェックボックスをオンにします。指定したフィールドを取り消すには、チェックボックスをオフにします。
●更新時のキーにするフィールドを指定する
実行する処理が「更新」の場合は (4)のフィールド一覧でキーにするフィールドのキーのチェックボックスをオンにします。キーの指定を取り消すには、キーのチェックボックスをオフにします。