転送設定一覧取得

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

= 備考 =

転送設定一覧取得APIのcontent階層下のレスポンスパラメータは、転送設定詳細取得APIのレスポンスパラメータの一部です。
書式
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIキー'
            'http://ホスト名:ポート番号/api/v1/profiles/profileId/sending-profiles?クエリ形式のリクエスト'
リクエストパラメータ（パス形式）
項目名 リクエストパラメータ 型 値 省略値
プロファイルID profileId 文字列   省略不可
リクエストパラメータ（クエリ形式）
項目名 リクエストパラメータ 型 値 省略値
ソート順 sort 文字列

"+パラメータ名"　|　"-パラメータ名"

•　+：昇順

•　-：降順

複数のパラメータを指定する場合は「,」で区切ります。

 +sendingProfileName
ページ数 page 数値

0始まりで指定します。

ページ数が1の場合、0を指定します。

 0
1ページ当たりの項目数 size 数値   10
ソート順に指定できるパラメータ
項目名 パラメータ名
圧縮方式 compressionMode
DEFLATEレベル deflateLevel
転送完了後ファイル削除（From） deleteFile
暗号キー encryptKey
暗号種別 encryptMode
ファイルID fileId
正常時ジョブ実行モード（From） jobExecMode
異常時ジョブ実行モード（From） jobExecModeOnError
正常時ジョブ（From） jobName
異常時ジョブ（From） jobNameOnError
配信前ジョブ実行モード（From） preJobExecMode
配信前ジョブ（From） preJobName
検索順序（From） searchOrderDescending
検索対象（From） searchTarget
転送設定ID sendingProfileId
転送設定名 sendingProfileName
転送タイプ sendType
監視ファイル名（From） triggerFileName
監視モード（From） triggerMode
レスポンス
{
   "content": [
            {
               "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"
            }
         ],
   "first": true,
   "last": true,
   "number": 0,
   "numberOfElements": 0,
   "size": 0,
   "sort": [],
   "totalElements": 0,
   "totalPages": 0
}
レスポンスパラメータ

content階層下のパラメータについては、「転送設定詳細取得」の「レスポンスパラメータ」を参照してください。

注意

以下のレスポンスパラメータは、このAPIからは返却されません。

  • dataVerify
  • fileCreation
  • generationFileCount
  • jobWait
  • receiveFileName
  • receiveJob
  • receiveJobId
  • receiveJobIdOnError
  • receiveJobOnError

また、ページ設定のパラメータ（first, last, number, numberOfElements, size, sort, totalElements, totalPages）については、「ページ設定に関するレスポンスパラメータ」を参照してください。