集信履歴の取得

集信履歴を取得します。

Request Interface

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

= 備考 =

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

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

PATH PARAMETERS

id : string

最新転送ID （必須）

集信履歴の「転送ID」を指定

指定した転送IDの履歴が集信終了日時の降順で999件以内に含まれている場合に取得可能

Response Interface

200 OK

RESPONSE HEADERS

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

RESPONSE SCHEMA : application/json

meta : object

メタデータ

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

製品バージョン

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圧縮
zstandard: : Zstandard圧縮

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

linux : object

Linux/AIX環境管理情報

connection_type : string

接続形態

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

lan: : LAN接続
other: : LAN接続以外の接続形式。SAN接続など

job_id : string

ジョブID

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: 詳細エラー情報

]

404 指定したIDが登録されていない

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: 詳細エラー情報

]