リクエストパラメータ一覧

リクエストパラメータの一覧です。項目名のアルファベット順、および五十音順に記載しています。

項目名 リクエストパラメータ 説明 参照先
DEFLATEレベル deflateLevel 転送ファイルを圧縮する際の圧縮率や圧縮速度を調整します。

「転送設定作成」

「転送設定情報更新」

MACアドレス macAddress  

「エージェント一覧取得」

OS os  

「アップデートモジュール一覧取得」

PID pid

ログを出力したエージェントのプロセスIDを指定します。

「トレースログ一覧取得」

アーキテクチャ（Agent） cpu Agentが動作するcpuアーキテクチャを指定します。

「アップデートモジュール一覧取得」

アクセス日時（開始） geAccessedDate 開始と終了の両方を指定した場合、検索対象にする期間を指定できます。

「アクセスログ一覧取得」

アクセス日時（終了） leAccessedDate 開始と終了の両方を指定した場合、検索対象にする期間を指定できます。

「アクセスログ一覧取得」

アクセスログタイプ type  

「アクセスログ一覧取得」

アクセスログの閾値（行数） offset ログを保存する行数の上限を指定します。

「システム設定（ログ）変更」

アクセスログの閾値（日付） minusDays

ログを保存する日数の上限を指定します。

例えば30を指定した場合、30日分のログを保存します。

「システム設定（ログ）変更」

アクセスログのトランケート（On/Off） enableTruncate  

「システム設定（ログ）変更」

アクセスログのトランケートモード truncateMode  

「システム設定（ログ）変更」

アクティベーションホワイトリスト whitelistEnabled ホワイトリスト機能の有効/無効を切り替えます。

「アクティベーションホワイトリスト機能ON/OFF」

値 value  

「ホワイトリスト登録」

圧縮方式 compressionMode 転送ファイルを圧縮するかどうかを選択します。

「転送設定作成」

「転送設定情報更新」

アップロードファイル名 ファイル名  

「アップデートモジュール登録」

宛先 (cc) cc

RFC準拠のメールアドレスを、カンマ（,）で区切って指定できます。

次のいずれかの形式で指定してください。

• foo@example.com

• <foo@example.com>

• foo <foo@example.com>

「システム設定（通知）変更」

「テストメール送信」

宛先 (To) address

RFC準拠のメールアドレスを、カンマ（,）で区切って指定できます。

次のいずれかの形式で指定してください。

• foo@example.com

• <foo@example.com>

• foo <foo@example.com>

「システム設定（通知）変更」

「テストメール送信」

暗号キー encryptKey

暗号種別でHULFT暗号を選択した場合、転送に使用する暗号キーを指定します。

Region Editionの場合、この項目は無視されます。

「転送設定作成」

「転送設定情報更新」

暗号種別 encryptMode

転送ファイルを暗号化するかどうかを選択します。

Region Editionの場合、この項目は無視されます。

「転送設定作成」

「転送設定情報更新」

異常時ジョブ （From） jobNameOnError 配信が失敗した場合に実行されるジョブを入力します。

「転送設定作成」

「転送設定情報更新」

異常時ジョブ （To） receiveJobOnError

ファイルの集信が異常終了したときにアプリケーションサーバで実行するジョブを入力します。

１ジョブ200文字まで、かつ最大13ジョブを指定できます。

ジョブごとに改行する必要があります。

「転送設定作成」

「転送設定情報更新」

異常時ジョブ実行モード（From） jobExecModeOnError 配信が失敗した場合に実行されるジョブをスクリプト単位で実行するか、ステップ単位で実行するか選択します。

「転送設定作成」

「転送設定情報更新」

1ページ当たりの項目数 size  

「ホワイトリスト一覧取得」

「エージェント一覧取得」

「受信タスク一覧取得」

「アクセスログ一覧取得」

「アップデートモジュール一覧取得」

「プロファイル一覧取得」

「受信設定一覧取得」

「転送設定一覧取得」

「受信履歴一覧取得」

「トレースログ一覧取得」

「転送履歴一覧取得」

「ユニット一覧取得」

「ユーザー一覧取得」

「管理対象ユニット一覧取得」

「ユーザーロール一覧取得」

イベント発生日時 （開始） geEventDate 開始と終了の両方を指定した場合、検索対象にする期間を指定できます。

「トレースログ一覧取得」

イベント発生日時（終了） leEventDate 開始と終了の両方を指定した場合、検索対象にする期間を指定できます。

「トレースログ一覧取得」

エージェントID agentId  

「エージェント一覧取得」

「エージェント詳細取得」

「エージェントステータス変更」

「エージェント動作設定変更」

「ユニット変更」

「プロファイル変更」

「モジュールバージョン変更」

「エージェント削除」

「受信タスク一覧取得」

「受信タスク削除」

「アクセスログ一覧取得」

「受信履歴一覧取得」

「トレースログ一覧取得」

「転送履歴一覧取得」

エージェントオフライン通知(ON/OFF) enableNotification  

「システム設定（通知）変更」

エージェントオフライン通知の閾値 offlineTime エージェントとのセッションが何分間オフラインになった場合に通知メールを送信するか、指定します。

「システム設定（通知）変更」

エージェントバージョン agentVersion  

「アクセスログ一覧取得」

エージェント名 agentName  

「エージェント一覧取得」

「受信履歴一覧取得」

「トレースログ一覧取得」

「転送履歴一覧取得」

エージェント名 name  

「エージェント動作設定変更」

エラー error  

「受信履歴一覧取得」

開始時刻（通信時間制限） startCommunicationTimeHour AgentがManagerと通信する時間帯を制限する場合、通信できる時間帯が始まる時刻を指定します。終了時刻と一緒に指定します。

「エージェント動作設定変更」

開始処理識別子 startProcessId  

「転送履歴一覧取得」

監視間隔 （From） triggerInterval 監視ファイル名に指定したファイルの状態を監視する間隔を指定します。

「転送設定作成」

「転送設定情報更新」

監視経過期間 （From） triggerElapsedTime 監視モードに応じた設定値を入力します。

「転送設定作成」

「転送設定情報更新」

監視サイズ（From） triggerSize 監視モードに応じた設定値を入力します。

「転送設定作成」

「転送設定情報更新」

監視ファイル名 （From） triggerFileName

監視対象のファイル名またはパスを指定します。パスを指定した場合は、パス直下のファイルをすべて監視します。

複数のファイルを監視する場合は、ファイル名中にワイルドカードとしてアスタリスク（*）を使用できます。

「転送設定作成」

「転送設定情報更新」

監視モード（From） triggerMode Agentが監視ファイルを配信する契機を指定します。

「転送設定作成」

「転送設定情報更新」

完了コード exitCode  

「受信履歴一覧取得」

利用期間ライセンスキー

 termKey  

「プロダクトキー更新」

利用期間ライセンスキー更新通知 (ON/OFF) enableNotification  

「システム設定（通知）変更」

利用期間ライセンスキー更新通知の閾値 beforeDays 有効期限の何日前に通知メールを送信するか、指定します。

「システム設定（通知）変更」

現在のパスワード currentPasswd 管理者が自分以外のユーザーのパスワードを変更するときは不要です。

「ユーザーパスワード変更」

検索順序（From） searchOrderDescending 同じトリガー発火タイミングで複数のファイルを転送するとき、Agentが転送ファイルを検索する順序を指定します。

「転送設定作成」

「転送設定情報更新」

検索対象 filter  

「転送履歴一覧取得」

検索対象（From） searchTarget 同じトリガー発火タイミングで複数のファイルを転送するとき、転送順序のキーとなる項目を指定します。

「転送設定作成」

「転送設定情報更新」

件名のプレフィックス subjectPrefix 通知メールの件名の先頭に追加する文字列を指定できます。

「システム設定（通知）変更」

件名のプレフィックス subjectPrefix テストメールの件名の先頭に追加する文字列を指定できます。

「テストメール送信」

コネクションリトライ回数 connectionRetryCount AgentがHULFTとの接続に失敗した場合に、再接続を試みる回数です。

「エージェント動作設定変更」

コネクションリトライ間隔 connectionRetryInterval AgentがHULFTとの接続に失敗した場合に、再接続を試みるまでの待ち時間です。

「エージェント動作設定変更」

最新処理識別子 latestProcessId  

「転送履歴一覧取得」

再発行キー clientSecret  

「APIキー再取得」

自動再配信リトライ回数 autoResendingRetryCount 通信エラーでHULFTへのファイル転送に失敗したとき、Agentが再配信を試みる回数です。

「エージェント動作設定変更」

自動再配信リトライ間隔 autoResendingRetryInterval 通信エラーでHULFTへのファイル転送に失敗したとき、Agentが再配信を試みるまでの待ち時間です。

「エージェント動作設定変更」

集信完了通知 （To） jobWait

ファイルの集信完了をAgentに通知するタイミングを指定します。

集信が完了したことが、指定したタイミングでManagerのログ画面に表示されます。

「転送設定作成」

「転送設定情報更新」

集信の完了コード rcvExitCode  

「転送履歴一覧取得」

集信ファイル名 （To） receiveFileName

転送されたファイルの集信側での名称を、絶対パスで指定します。複数のファイルを監視している場合、集信したファイルは同じ名称になります。

「転送設定作成」

「転送設定情報更新」

集信ポート番号 shushinPort  

「ユニット一覧取得」

「ユニット作成」

「ユニット情報更新」

「管理対象ユニット一覧取得」

集信ホスト名 shushinHostName  

「転送履歴一覧取得」

「ユニット一覧取得」

「ユニット作成」

「ユニット情報更新」

「管理対象ユニット一覧取得」

終了時刻（通信時間制限） endCommunicationTimeHour AgentがManagerと通信する時間帯を制限する場合、通信できる時間帯が終わる時刻を指定します。開始時刻と一緒に指定します。

「エージェント動作設定変更」

受信開始日時 （UTC） receivingStartDateUtc  

「受信履歴一覧取得」

受信開始日時 （文字列） receivingStartDateStr  

「受信履歴一覧取得」

受信開始日時 （文字列）(開始) geReceivingStartDate 開始と終了の両方を指定した場合、検索対象にする期間を指定できます。

「受信履歴一覧取得」

受信開始日時 （文字列）(終了) leReceivingStartDate 開始と終了の両方を指定した場合、検索対象にする期間を指定できます。

「受信履歴一覧取得」

受信キューポーリング間隔 receivingQueuePollingInterval Agentが受信タスクキューをポーリングする間隔です。

「エージェント動作設定変更」

受信終了日時 （UTC） receivingEndDateUtc  

「受信履歴一覧取得」

受信終了日時 （文字列） receivingEndDateStr  

「受信履歴一覧取得」

受信終了日時 （文字列）(開始) geReceivingEndDate 開始と終了の両方を指定した場合、検索対象にする期間を指定できます。

「受信履歴一覧取得」

受信終了日時 （文字列）(終了) leReceivingEndDate 開始と終了の両方を指定した場合、検索対象にする期間を指定できます。

「受信履歴一覧取得」

受信設定ID receivingProfileId  

「ファイル配付」

「受信履歴一覧取得」

「受信設定詳細取得」

「受信設定情報更新」

「受信設定削除」

受信設定名 receivingProfileName  

「受信設定作成」

「受信履歴一覧取得」

「受信設定情報更新」

受信タスクID receivingTaskId  

「受信タスク削除」

受信タスクキューサイズ receivingTaskQueueSize 受信タスクキューに登録できるファイル配付タスクの最大数です。指定した数を超える場合、古いタスクから順に削除されます。

「エージェント動作設定変更」

受信履歴ID receivingLogId  

「受信履歴詳細取得」

受信履歴エラー通知 (ON/OFF) enableNotification  

「システム設定（通知）変更」

受信履歴の閾値（行数） offset ログを保存する行数の上限を指定します。

「システム設定（ログ）変更」

受信履歴の閾値（日付） minusDays

ログを保存する日数の上限を指定します。

例えば30を指定した場合、30日分のログを保存します。

「システム設定（ログ）変更」

受信履歴のトランケート（On/Off） enableTruncate  

「システム設定（ログ）変更」

受信履歴のトランケートモード truncateMode  

「システム設定（ログ）変更」

ジョブの内容 jobScript 配付ファイルの受信が成功したときに実行するジョブを記入します。

「受信設定作成」

「受信設定情報更新」

ジョブタイムアウト（時間） jobTimeout

ファイル転送およびファイル配付の際に実行するジョブの実行結果が返ってこなかったとき、エラーにするまでの待ち時間です。

「エージェント動作設定変更」

ジョブタイムアウト（有効/無効） jobTimeoutEnabled

ファイル転送およびファイル配付の際に実行するジョブの実行結果が返ってこなかったとき、エラーにするかどうかを指定します。

無効にした場合は、実行結果を待ち続けます。

「エージェント動作設定変更」

ジョブ完了コード jobExitCode  

「受信履歴一覧取得」

ジョブ実行モード

（受信設定）

 jobExecMode 配付ファイルの受信が成功したときに実行されるジョブを、スクリプト単位で実行するかステップ単位で実行するかを選択します。

「受信設定作成」

「受信設定情報更新」

シリアル番号 serial  

「プロダクトキー更新」

新パスワード newPasswd  

「ユーザーパスワード変更」

ステータス（Agent） status  

「エージェント一覧取得」

「エージェントステータス変更」

正常時ジョブ （From） jobName 配信が成功した場合に実行されるジョブを入力します。

「転送設定作成」

「転送設定情報更新」

正常時ジョブ （To） receiveJob

ファイルの集信が正常終了したときにアプリケーションサーバで実行するジョブを入力します。

１ジョブ200文字まで、かつ最大13ジョブを指定できます。

ジョブごとに改行する必要があります。

「転送設定作成」

「転送設定情報更新」

正常時ジョブ実行モード（From） jobExecMode 配信が成功した場合に実行されるジョブをスクリプト単位で実行するか、ステップ単位で実行するかを選択します。

「転送設定作成」

「転送設定情報更新」

世代管理数 （To） generationFileCount ファイル作成方法で"GEN_CTL"（世代管理）を選択した場合、管理する世代数を指定します。

「転送設定作成」

「転送設定情報更新」

ソート順 sort  

「エージェント一覧取得」

「アクセスログ一覧取得」

「プロファイル一覧取得」

「受信設定一覧取得」

「転送設定一覧取得」

「受信履歴一覧取得」

「トレースログ一覧取得」

「転送履歴一覧取得」

「ユニット一覧取得」

「ユーザー一覧取得」

「管理対象ユニット一覧取得」

属性 attribute  

「ホワイトリスト一覧取得」

「ホワイトリスト登録」

ソケットバッファサイズ （タイプ） socketBufferSizeMode

AgentがHULFTとのソケット通信で使用するソケットバッファのタイプを指定します。

［ユーザー指定］を選択した場合は、バイト数を指定します。

「エージェント動作設定変更」

ソケットバッファサイズ （バイト数） socketBufferSize AgentがHULFTとのソケット通信で使用するソケットバッファサイズを指定します。

「エージェント動作設定変更」

ソケットリードタイムアウト socketTimeout

AgentとHULFTとのソケット通信で、HULFTからの応答がなかった場合に、Agentがタイムアウトするまでの時間です。

タイムアウトした場合、Agentは通信異常と判断して通信を切断します。

「エージェント動作設定変更」

通信時間制限 communicationTimeLimitEnabled AgentがManagerと通信する時間帯を制限するかどうかを指定します。

「エージェント動作設定変更」

データ検証 dataVerify 集信側で転送ファイルのデータを検証するかどうかを選択します。

「転送設定作成」

「転送設定情報更新」

転送完了後ファイル削除（From） deleteFile

転送完了後に転送したファイルを削除するかしないかを指定します。

なお、ファイルを削除しない場合、再度ファイルが検知されるため正常時ジョブでファイルを削除するようにしてください。

「転送設定作成」

「転送設定情報更新」

転送設定ID sendingProfileId  

「転送設定詳細取得」

「転送設定情報更新」

「転送設定削除」

転送設定名 sendingProfileName  

「転送設定作成」

「転送設定情報更新」

転送タイプ sendType

転送データをバイナリデータとして扱うか、テキストデータとして扱うかを選択します。

テキストデータとして扱う場合、文字コードや改行コードを変換して転送します。

「転送設定作成」

「転送設定情報更新」

転送履歴ID transferLogId  

「転送履歴詳細取得」

転送履歴エラー通知 (ON/OFF) enableNotification  

「システム設定（通知）変更」

転送履歴の閾値（行数） offset ログを保存する行数の上限を指定します。

「システム設定（ログ）変更」

転送履歴の閾値（日付） minusDays

ログを保存する日数の上限を指定します。

例えば30を指定した場合、30日分のログを保存します。

「システム設定（ログ）変更」

転送履歴のトランケート（On/Off） enableTruncate  

「システム設定（ログ）変更」

転送履歴のトランケートモード truncateMode  

「システム設定（ログ）変更」

テンポラリファイル転送（From） temporaryFile

有効にした場合、テンポラリを使ったファイル転送処理が行われます。ファイルを転送前にテンポラリファイル名にリネームしてから転送します。

転送中も継続して同じファイル名を使用し続けたい場合に使用します。

「転送設定作成」

「転送設定情報更新」

登録日（開始） geRegistrationDate 開始と終了の両方を指定した場合、検索対象にする期間を指定できます。

「エージェント一覧取得」

「アップデートモジュール一覧取得」

登録日（終了） leRegistrationDate 開始と終了の両方を指定した場合、検索対象にする期間を指定できます。

「エージェント一覧取得」

「アップデートモジュール一覧取得」

トレースログエラー通知 (ON/OFF) enableNotification  

「システム設定（通知）変更」

トレースログのトランケート（On/Off） enableTruncate  

「システム設定（ログ）変更」

トレースログのトランケートモード truncateMode  

「システム設定（ログ）変更」

トレースログの閾値（行数） offset ログを保存する行数の上限を指定します。

「システム設定（ログ）変更」

トレースログの閾値（日付） minusDays

ログを保存する日数の上限を指定します。

例えば30を指定した場合、30日分のログを保存します。

「システム設定（ログ）変更」

トレースログユニークID traceLogUniqueId  

「トレースログ詳細取得」

トレースログ保管サイズ traceLogPoolSize Agentに保管するトレースログの量を指定します。

「エージェント動作設定変更」

配信多重度 sendProcessMultiplexLevel

Agentが同時に起動できる配信プロセスの最大数を指定します。

Agent内の転送ファイルの数が配信プロセスの最大数を超えた場合、Agentは超えた分の転送ファイルを、プロファイル転送設定画面で指定された［監視間隔］が経過したあとの、次回のトリガー発火タイミングに持ち越します。

「エージェント動作設定変更」

配信の完了コード sndExitCode  

「転送履歴一覧取得」

配信前ジョブ （From） preJobName 配信処理前に実行されるジョブを入力します。

「転送設定作成」

「転送設定情報更新」

配信前ジョブ実行モード（From） preJobExecMode

配信前ジョブをスクリプト単位で実行するか、ステップ単位で実行するか、選択します。

「転送設定作成」

「転送設定情報更新」

配信履歴保管サイズ sendLogPoolSize Agentに保管する配信履歴の量を指定します。

「エージェント動作設定変更」

配置先ファイル名 fileName 配付ファイルをIoT機器で受信したときのファイル名を、IoT機器でのファイルの格納先となる絶対パスで指定します。

「受信設定作成」

「受信設定情報更新」

パスワード password  

「APIキー取得」

パスワード newPasswd  

「ユーザー作成」

ビット数（Agent） bit Agentモジュールのビット数を指定します。

「アップデートモジュール一覧取得」

ファイルID fileId

転送に使用するファイルIDです。

「転送設定作成」

「転送設定情報更新」

ファイルID fileId

転送に使用されたファイルIDです。

「転送履歴一覧取得」

ファイル作成方法 （To） fileCreation

集信側でのファイルの作成方法を選択します。

"REPLACE" | "NEW_CREATION" | "APPEND" | "GEN_CTL"

•　REPLACE：［置き換え］

•　NEW_CREATION：［新規作成］

•　APPEND：［追加書き］

•　GEN_CTL：［世代管理］

「転送設定作成」

「転送設定情報更新」

ファイル名 ファイル名  

「ファイル配付」

プロダクトキー productKey  

「プロダクトキー更新」

プロファイルID profileId  

「エージェント一覧取得」

「プロファイル変更」

「アクセスログ一覧取得」

「プロファイル一覧取得」

「プロファイル詳細取得」

「プロファイル情報更新」

「プロファイル削除」

「受信設定一覧取得」

「受信設定作成」

「転送設定一覧取得」

「転送設定作成」

「受信履歴一覧取得」

「転送履歴一覧取得」

プロファイルバージョン profileVersion  

「アクセスログ一覧取得」

プロファイル名 profileName  

「エージェント一覧取得」

「プロファイル一覧取得」

「プロファイル情報更新」

「受信履歴一覧取得」

「転送履歴一覧取得」

「プロファイル作成」

ページ数 page  

「ホワイトリスト一覧取得」

「エージェント一覧取得」

「受信タスク一覧取得」

「アクセスログ一覧取得」

「アップデートモジュール一覧取得」

「プロファイル一覧取得」

「受信設定一覧取得」

「転送設定一覧取得」

「受信履歴一覧取得」

「トレースログ一覧取得」

「転送履歴一覧取得」

「ユニット一覧取得」

「ユーザー一覧取得」

「管理対象ユニット一覧取得」

「ユーザーロール一覧取得」

ポーリング間隔 pollingInterval AgentがManagerをポーリングする間隔を指定します。

「エージェント動作設定変更」

ホスト名 hostName  

「受信履歴一覧取得」

ホスト名 host  

「エージェント一覧取得」

ホワイトリストID activationWhiteListId  

「ホワイトリスト削除」

メール送信 (ON/OFF) enableNotification  

「システム設定（通知）変更」

モジュールID moduleId  

「アップデートモジュール一覧取得」

「アップデートモジュール削除」

モジュールバージョン moduleVersion  

「モジュールバージョン変更」

「アクセスログ一覧取得」

「アップデートモジュール一覧取得」

モジュールファイル名 moduleFileName  

「アップデートモジュール一覧取得」

ユーザーID userId  

「ユーザー詳細取得」

「ユーザー情報更新」

「ユーザーパスワード変更」

「ユーザー削除」

「管理対象ユニット一覧取得」

「管理対象ユニットアタッチ」

「管理対象ユニットデタッチ」

ユーザー名 userName  

「APIキー取得」

「ユーザー一覧取得」

「ユーザー作成」

「ユーザー情報更新」

ユニットID unitId  

「エージェント一覧取得」

「ユニット変更」

「アクセスログ一覧取得」

「プロファイル一覧取得」

「受信履歴一覧取得」

「転送履歴一覧取得」

「ユニット一覧取得」

「ユニット詳細取得」

「ユニット情報更新」

「ユニット削除」

「プロファイル作成」

「管理対象ユニット一覧取得」

「管理対象ユニットデタッチ」

ユニットID（アレイ） unitIds   「管理対象ユニットアタッチ」
ユニットバージョン unitVersion  

「アクセスログ一覧取得」

ユニット名 unitName  

「エージェント一覧取得」

「プロファイル一覧取得」

「受信履歴一覧取得」

「転送履歴一覧取得」

「ユニット一覧取得」

「ユニット作成」

「ユニット情報更新」

「管理対象ユニット一覧取得」

リクエストタイムアウト requestTimeout

AgentからManagerへのすべての通信で、Managerからの応答がなかった場合に、Agentがタイムアウトするまでの時間を指定します。

タイムアウトした場合、Agentは通信異常と判断して通信を切断します。

「エージェント動作設定変更」

履歴出力モード historyMode 配信履歴を常時出力するか、エラーが発生したときにだけ出力するかを選択します。

「エージェント動作設定変更」

履歴出力モード（集信履歴設定） hulrcvLogHistoryMode 集信履歴を常時出力するか、エラーが発生したときにだけ出力するかを選択します。

「システム設定（ログ）変更」

ロールID userRoleId  

「ユーザー作成」

ロール名 userRoleName  

「ユーザー一覧取得」

ログレベル logLevel  

「トレースログ一覧取得」