転送設定詳細取得

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

= 備考 =

転送設定一覧取得APIとの違いは、レスポンスに次のパラメータが含まれないことです。

  • content階層（階層下のパラメータは、一覧取得APIと詳細取得APIですべて同じです）

  • first

  • last

  • number

  • numberOfElements

  • size

  • sort

  • totalElements

  • totalPages
書式
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIキー'
            'http://ホスト名:ポート番号/api/v1/sending-profiles/sendingProfileId'
リクエストパラメータ（パス形式）
項目名 リクエストパラメータ 型 値 省略値
転送設定ID sendingProfileId 文字列   省略不可
レスポンス
{
  "compressionMode": 0,
  "deflateLevel": 0,
  "deleteFile": "string",
  "encryptMode": 0,
  "fileId": "string",
  "jobExecMode": 0,
  "jobExecModeOnError": 0,
  "jobName": "string",
  "jobNameOnError": "string",
  "preJobExecMode": 0,
  "preJobName": "string",
  "profileId": "string",
  "searchOrderDescending": true,
  "searchTarget": 0,
  "sendingProfileId": "string",
  "sendingProfileName": "string",
  "sendType": "string",
  "temporaryFile": true,
  "triggerElapsedTime": "string",
  "triggerFileName": "string",
  "triggerInterval": "string",
  "triggerMode": "string",
  "triggerSize": "string",
  "dataVerify": true,
  "fileCreation": "string",
  "generationFileCount": 0,
  "jobWait": "string",
  "receiveFileName": "string",
  "receiveJob": "string",
  "receiveJobOnError": "string"
}
レスポンスパラメータ
項目名 レスポンスパラメータ 型 値
圧縮方式 compressionMode 数値

0 | 1

•　0：圧縮なし

•　1：DEFLATE圧縮
DEFLATEレベル deflateLevel 数値

1 | 2 | 3

•　1：標準

•　2：圧縮率優先

•　3：圧縮速度優先
転送完了後ファイル削除（From） deleteFile 文字列

"K" | "D"

•　K：削除しない

•　D：削除する
暗号種別 encryptMode 数値

0 | 1

•　0：暗号なし※

•　1：HULFT暗号

※ Region Editionの場合は、必ず0が設定されます。
ファイルID fileId 文字列  
正常時ジョブ実行モード（From） jobExecMode 数値

0　|　1

•　0：スクリプト実行

•　1：ステップ実行
異常時ジョブ実行モード（From） jobExecModeOnError 数値

0　|　1

•　0：スクリプト実行

•　1：ステップ実行
正常時ジョブ（From） jobName 文字列

2048文字以内のASCII文字（NULLを除く）
異常時ジョブ（From） jobNameOnError 文字列

2048文字以内のASCII文字（NULLを除く）
配信前ジョブ実行モード（From） preJobExecMode 数値

0　|　1

•　0：スクリプト実行

•　1：ステップ実行
配信前ジョブ（From） preJobName 文字列 2048文字以内のASCII文字（NULLを除く）
プロファイルID profileId 文字列  
検索順序（From） searchOrderDescending 論理型

•　true：降順

•　false：昇順
検索対象（From） searchTarget 数値

1　|　2

•　1：ファイル名

•　2：更新日時
転送設定ID sendingProfileId 文字列  
転送設定名 sendingProfileName 文字列 1文字以上、64文字以内
転送タイプ sendType 文字列

"B"　|　"T"

•　B：バイナリ

•　T：テキスト
テンポラリファイル転送（From） temporaryFile 論理型

•　true：テンポラリファイル転送する

•　false：テンポラリファイル転送しない
監視経過期間（From） triggerElapsedTime 文字列

"1s"　～　"59d"

数値(1～59)と単位

　(単位は秒：s、分：m、時間：h、日：d)
監視ファイル名（From） triggerFileName 文字列

256バイト以内の文字列（NULLを除く）

ワイルドカードの指定可能
監視間隔（From） triggerInterval 文字列

"1s"　～　"59d"

数値(1～59)と単位

　(単位は秒：s、分：m、時間：h、日：d)
監視モード（From） triggerMode 文字列

"SIZE"　|　"TIMESTAMP"

•　SIZE：サイズ

•　TIMESTAMP：経過期間
監視サイズ（From） triggerSize 文字列

"1b"　～　"1023g"

数値(1～1023)と単位

　(単位はバイト：b、キロバイト：k、メガバイト：m、ギガバイト：g)
データ検証 dataVerify 論理型

•　true：検証する

•　false：検証しない
ファイル作成方法（To） fileCreation 文字列

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

•　REPLACE：置き換え

•　NEW_CREATION：新規作成

•　APPEND：追加書き

•　GEN_CTL：世代管理
世代管理数（To） generationFileCount 数値

0, 2　～　9999

fileCreationが"GEN_CTL"（世代管理）以外のときは、0が返却されます。
集信完了通知（To） jobWait 文字列

"Receive" | "Successful_Job"

•　Receive：受信完了

•　Successful_Job：正常時ジョブ完了
集信ファイル名（To） receiveFileName 文字列  
正常時ジョブ（To） receiveJob 文字列 ジョブが複数登録されている場合は改行コード（LF）で区切られます。
異常時ジョブ（To） receiveJobOnError 文字列 ジョブが複数登録されている場合は改行コード（LF）で区切られます。