転送設定作成

転送設定を作成するためのAPIです。Manager画面で［プロファイル］を選択した後、プロファイルを選択したときに表示される画面での［転送設定］の操作に相当します。

= 備考 =

次のAPIのJSON形式のリクエストパラメータは同じです。

転送設定作成API
転送設定情報更新API

次のAPIのレスポンスパラメータは同じです。

転送設定作成API
転送設定情報更新API
転送設定詳細取得API

書式
リクエストボディ（JSON形式）
リクエストパラメータ（JSON形式）
リクエストパラメータ（パス形式）
レスポンス
レスポンスパラメータ

項目名	リクエストパラメータ	型	値	省略値
圧縮方式	compressionMode	数値	転送ファイルを圧縮するかどうかを選択します。 0 \| 1 •　0：圧縮なし •　1：DEFLATE圧縮	0
DEFLATEレベル	deflateLevel	数値	転送ファイルを圧縮する際の圧縮率や圧縮速度を調整します。 1 \| 2 \| 3 •　1：標準 •　2：圧縮率優先 •　3：圧縮速度優先	1
転送完了後ファイル削除（From）	deleteFile	文字列	転送完了後に転送したファイルを削除するかしないかを指定します。なお、ファイルを削除しない場合、再度ファイルが検知されるため正常時ジョブでファイルを削除するようにしてください。 "K" \| "D" •　K：削除しない •　D：削除する	"D"
暗号キー	encryptKey	文字列	暗号種別でHULFT暗号を選択した場合、転送に使用する暗号キーを指定します。 8文字以上、20文字以内の半角英数字　^※ ※　Region Editionの場合、この項目は無視されます。	encryptModeに1を指定した場合は省略不可
暗号種別	encryptMode	数値	転送ファイルを暗号化するかどうかを選択します。 0 \| 1 ^※ •　0：暗号なし •　1：HULFT暗号 ※　Region Editionの場合、この項目は無視されます。	Region Editionの場合は省略可、それ以外の場合は省略不可
ファイルID	fileId	文字列	転送に使用するファイルIDです。 1文字以上、50文字以内	省略不可
正常時ジョブ実行モード（From）	jobExecMode	数値	配信が成功した場合に実行されるジョブをスクリプト単位で実行するか、ステップ単位で実行するかを選択します。 0　\|　1 •　0：スクリプト実行 •　1：ステップ実行	0
異常時ジョブ実行モード（From）	jobExecModeOnError	数値	配信が失敗した場合に実行されるジョブをスクリプト単位で実行するか、ステップ単位で実行するか選択します。 0　\|　1 •　0：スクリプト実行 •　1：ステップ実行	0
正常時ジョブ（From）	jobName	文字列	配信が成功した場合に実行されるジョブを入力します。 2048文字以内のASCII文字（NULLを除く）
異常時ジョブ（From）	jobNameOnError	文字列	配信が失敗した場合に実行されるジョブを入力します。 2048文字以内のASCII文字（NULLを除く）
配信前ジョブ実行モード（From）	preJobExecMode	数値	配信前ジョブをスクリプト単位で実行するか、ステップ単位で実行するか、選択します。 0　\|　1 •　0：スクリプト実行 •　1：ステップ実行
配信前ジョブ（From）	preJobName	文字列	配信処理前に実行されるジョブを入力します。 2048文字以内のASCII文字（NULLを除く）
検索順序（From）	searchOrderDescending	論理型	同じトリガー発火タイミングで複数のファイルを転送するとき、Agentが転送ファイルを検索する順序を指定します。 •　true：降順 •　false：昇順	false
検索対象（From）	searchTarget	数値	同じトリガー発火タイミングで複数のファイルを転送するとき、転送順序のキーとなる項目を指定します。 1　\|　2 •　1：ファイル名 •　2：更新日時	2
転送設定名	sendingProfileName	文字列	1文字以上、64文字以内	省略不可
転送タイプ	sendType	文字列	転送データをバイナリデータとして扱うか、テキストデータとして扱うかを選択します。テキストデータとして扱う場合、文字コードや改行コードを変換して転送します。 "B"　\|　"T" •　B：バイナリ •　T：テキスト	"B"
テンポラリファイル転送（From）	temporaryFile	論理型	有効にした場合、テンポラリを使ったファイル転送処理が行われます。ファイルを転送前にテンポラリファイル名にリネームしてから転送します。転送中も継続して同じファイル名を使用し続けたい場合に使用します。 •　true：テンポラリファイル転送する •　false：テンポラリファイル転送しない	false
監視経過期間（From）	triggerElapsedTime	文字列	監視モードに応じた設定値を入力します。 "1s"　～　"59d" 数値（1～59）と単位を入力する。 (単位は秒：s、分：m、時間：h、日：d)	"1m"
監視ファイル名（From）	triggerFileName	文字列	監視対象のファイル名またはパスを指定します。パスを指定した場合は、パス直下のファイルをすべて監視します。複数のファイルを監視する場合は、ファイル名中にワイルドカードとしてアスタリスク（*）を使用できます。 256バイト以内の文字列（?"<>\| は指定不可）	省略不可
監視間隔（From）	triggerInterval	文字列	監視ファイル名に指定したファイルの状態を監視する間隔を指定します。 "1s"　～　"59d" 数値（1～59）と単位を入力する。 (単位は秒：s、分：m、時間：h、日：d)	"1m"
監視モード（From）	triggerMode	文字列	Agentが監視ファイルを配信する契機を指定します。 "SIZE"　\|　"TIMESTAMP" •　SIZE：サイズ •　TIMESTAMP：経過期間	"SIZE"
監視サイズ（From）	triggerSize	文字列	監視モードに応じた設定値を入力します。 "1b"　～　"1023g" 数値（1 ～ 1023）と単位を入力する。 (単位はバイト：b、キロバイト：k、メガバイト：m、ギガバイト：g)	"1k"
データ検証	dataVerify	論理型	集信側で転送ファイルのデータを検証するかどうかを選択します。 •　true：検証する •　false：検証しない	省略不可
ファイル作成方法（To）	fileCreation	文字列	集信側でのファイルの作成方法を選択します。 "REPLACE" \| "NEW_CREATION" \| "APPEND" \| "GEN_CTL" •　REPLACE：［置き換え］ •　NEW_CREATION：［新規作成］ •　APPEND：［追加書き］ •　GEN_CTL：［世代管理］一つのホストからだけファイルを集信する場合は、［置き換え］、［新規作成］、［世代管理］のうちのどれかを指定します。複数のホストからファイルを集信する場合は、［追加書き］を指定します。 • ［置き換え］：古いファイルを新しいファイルで置き換えます。［集信ファイル名］で指定したファイルが集信側に存在しない場合、ファイルが作成されます。 • ［新規作成］：新しいファイルを作成します。既に同じ名前のファイルがあった場合は、エラーになります。 • ［追加書き］：既存のファイルの末尾に受信データを追加して、集信したファイルを一つのファイルにまとめます。［集信ファイル名］で指定したファイルが集信側に存在しない場合、ファイルが作成されます。 • ［世代管理］：指定した世代数分のファイルが作成されます。例えば、［集信ファイル名］にC:\test\rcv.txtを設定した場合、「rcv.txt.0001」、「rcv.txt.0002」のように拡張子の後ろに通し番号付きでファイルが保存されます。集信に失敗した場合、Agentは転送ファイルを次のように処理します。 • ［置き換え］：保存転送ファイルは、監視対象ディレクトリに残ります。 • ［新規作成］：削除転送ファイルは、監視対象ディレクトリから削除されます。 • ［追加書き］：保存転送ファイルは、監視対象ディレクトリに残ります。 • ［世代管理］：削除転送ファイルは、監視対象ディレクトリから削除されます。	省略不可
世代管理数（To）	generationFileCount	数値	ファイル作成方法で"GEN_CTL"（世代管理）を選択した場合、管理する世代数を指定します。 0, 2　～　9999 「fileCreation」が"GEN_CTL"（世代管理）以外のときは、0を設定します。	省略不可
集信完了通知（To）	jobWait	文字列	ファイルの集信完了をAgentに通知するタイミングを指定します。集信が完了したことが、指定したタイミングでManagerのログ画面に表示されます。 "Receive" \| "Successful_Job" •　Receive：受信完了 •　Successful_Job：正常時ジョブ完了	省略不可
集信ファイル名（To）	receiveFileName	文字列	転送されたファイルの集信側での名称を、絶対パスで指定します。複数のファイルを監視している場合、集信したファイルは同じ名称になります。 200文字以内のASCII文字（NULLを除く）	省略不可
正常時ジョブ（To）	receiveJob	文字列	ファイルの集信が正常終了したときにアプリケーションサーバで実行するジョブを入力します。 ASCII文字のみ１ジョブ200文字まで、かつ最大13ジョブを指定できます。ジョブの区切りには、改行コード(CRLFまたはLF)を挿入してください。
異常時ジョブ（To）	receiveJobOnError	文字列	ファイルの集信が異常終了したときにアプリケーションサーバで実行するジョブを入力します。最大13ジョブを指定できます。ジョブごとに改行する必要があります。 ASCII文字のみ１ジョブ200文字まで、かつ最大13ジョブを指定できます。ジョブの区切りには、改行コード(CRLFまたはLF)を挿入してください。