受信設定一覧取得
受信設定の一覧を取得するためのAPIです。Manager画面で[プロファイル]を選択した後、プロファイルを選択したときに表示される画面での[受信設定]の操作に相当します。
= 備考 =
受信設定一覧取得APIのcontent階層下のレスポンスパラメータは、受信設定詳細取得APIのレスポンスパラメータと同じです。 |
- 書式
- リクエストパラメータ(パス形式)
- リクエストパラメータ(クエリ形式)
- ソート順に指定できるパラメータ
- レスポンス
- レスポンスパラメータ
|
項目名 | リクエストパラメータ | 型 | 値 | 省略値 |
---|---|---|---|---|
プロファイルID | profileId | 文字列 | 省略不可 |
項目名 | リクエストパラメータ | 型 | 値 | 省略値 |
---|---|---|---|---|
ソート順 | sort | 文字列 |
"+パラメータ名" | "-パラメータ名" • +:昇順 • -:降順 複数のパラメータを指定する場合は「,」で区切ります。 |
+receivingProfileName |
ページ数 | page | 数値 |
0始まりで指定します。 ページ数が1の場合、0を指定します。 |
0 |
1ページ当たりの項目数 | size | 数値 | 10 |
項目名 | パラメータ名 |
---|---|
配置先ファイル名 | fileName |
ジョブ実行モード | jobExecMode |
ジョブの内容 | jobScript |
受信設定ID | receivingProfileId |
受信設定名 | receivingProfileName |
|
content階層下のパラメータについては、「受信設定詳細取得」の「レスポンスパラメータ」を参照してください。
また、ページ設定のパラメータ(first, last, number, numberOfElements, size, sort, totalElements, totalPages)については、「ページ設定に関するレスポンスパラメータ」を参照してください。