集信履歴の一覧取得

集信履歴の一覧を取得します。

Request Interface

http://ControlURL/api/v1/hulft/{hulft-host-id}/logs/receivings/list

= 備考 =

上のRequest InterfaceのURLで、斜体の文字部分に指定するパスについては以下を参照してください。

HULFT10 API Gateway ガイド : Request Interfaceの指定

QUERY PARAMETERS

limit : integer

検索件数の上限

省略すると、“100”が設定されます。

file-id : string

検索したいファイルIDを指定

50バイト以内の文字列で指定します。

省略した場合は、すべてのファイルIDが対象となります。

hostname : string

検索したいホスト名を指定

68バイト以内の文字列で指定します。

省略した場合は、すべてのホストIDが対象となります。

status : string

ステータス区分

以下のいずれかを指定します。

all (A): : すべての履歴を対象
normal (N): : 正常終了した履歴のみを対象
error (E): : 異常が起きた履歴のみを対象

省略した場合は、“all”を設定します。

from-end-date : string

検索範囲の開始日付を指定

「YYYYMMDD」の形式で指定します。

接続先ホストのタイムゾーンで指定します。

省略した場合は、最古の履歴までが検索範囲となります。

from-end-time : string

検索範囲の開始時刻を指定

形式はHHMMSSです。

開始日付を省略した場合、指定できません。

省略した場合は、“000000”を設定します。

to-end-date : string

検索範囲の終了日付を指定

「YYYYMMDD」の形式で指定します。

接続先ホストのタイムゾーンで指定します。

省略した場合は、最新の履歴までが検索範囲となります。

to-end-time : string

検索範囲の終了時刻を指定

形式はHHMMSSです。

終了日付を省略した場合、指定できません。

省略した場合は、“235959”を設定します。

Response Interface

200 OK

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

meta : object

メタ情報

total : integer

取得したレコードの総数

os_type : string

接続先ホスト機種

以下のいずれかが取得されます。

windows: : Windows環境
linux: : Linux/AIX環境
ibmi: : IBM i（AS/400）環境
zos: : z/OS（汎用機）環境

request_user_role : string

API実行ユーザーの権限

以下のいずれかが取得されます。

admin: : ユーザーの管理や接続先HULFTの追加を行うことができる権限
member: : 登録済みのHULFTへの接続を行うことができる権限

strong_key_mode : string

高強度暗号強制モードの設定値

以下のいずれかが取得されます。

disable: : 無効
enable: : 有効

product_version : string

製品バージョン

records : Array of objects

検索結果に一致するレコードのうちリミットまで取り出したもの

以下の構造の情報（Array[]）が複数取得されます。

Array[

file_id : string

ファイルID

id : object

latest_transfer : string: 転送ID
latest_process : string: 処理ID

comment : string

status : object

実行結果

code : integer: 完了コード
detail : integer: 詳細コード
description : string: 内容
measure : string: 対処

file : object

集信ファイル

name : string

ファイル名

transferred : object

転送済みファイル情報

rows : integer: 転送済みレコード件数
size : integer: 転送済みデータサイズ(bytes)

communication : object

接続情報

host : string

ホスト名

ip_version : string

IPバージョン

以下のいずれかが取得されます。

ipv4: : IPv4で接続
ipv6: : IPv6で接続

rate : number

転送レート

datetime : object

日時情報

start : string <date-time>: 開始日時
end : string <date-time>: 終了日時

compression : object

圧縮情報

type : string

圧縮方式

以下のいずれかが取得されます。

none: : 圧縮なし
horizontal: : レコード内圧縮
vertical: : レコード間圧縮
deflate: : DEFLATE圧縮

database_id : string

連携DBID

security : object

セキュリティ

encryption_scheme : string

暗号化種別

以下のいずれかが取得されます。

none: : 暗号機能を使用していない
hulft: : HULFT暗号化
c4s: : HULFT 暗号オプション（C4S）
aes: : HULFT 暗号オプション（AES）
other: : その他の暗号化方式

message : object

メッセージ

short : Array of strings: メッセージ0～5
long : Array of strings: 拡張メッセージ0～1

ibmi : object

IBM i（AS/400）環境管理情報

job_number : string: ジョブ番号

]

400 リクエストエラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string

エラー種別

description : string

エラーの説明

measure : string

対処方法

detail : string

詳細エラー情報

additional : (Error1(object or null)) or (Error2(object or null))

"Error1"、"Error2"のいずれかが取得されます。

Error1

message : string: バリデーションエラーメッセージ
fields : string: バリデーションフィールド情報

Error2

code : integer: HULFT実行結果
detail : string: HULFT詳細コード
latest_process_id : string: 最新処理ID
message : string: HULFTエラーメッセージ

]

401 認証エラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

403 認可エラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string: エラー種別
description : string: エラーの説明
measure : string: 対処方法
detail : string: 詳細エラー情報

]

500 サーバー内部エラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string: エラー種別
description : string: エラーの説明
measure : string: 対処方法
detail : string: 詳細エラー情報

]

502 HULFT接続エラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string

エラー種別

description : string

エラーの説明

measure : string

対処方法

detail : string

詳細エラー情報

additional : object

HULFTエラー追加情報

code : integer: HULFT実行結果
detail : string: HULFT詳細コード
latest_process_id : string: 最新処理ID
message : string: HULFTエラーメッセージ

]

504 タイムアウトエラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string: エラー種別
description : string: エラーの説明
measure : string: 対処方法
detail : string: 詳細エラー情報

]