配信管理情報の取得

登録済みの配信管理情報を取得します。

Request Interface

http://ControlURL/api/v1/hulft/{hulft-host-id}/managements/sendings/detail/{id}

= 備考 =

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

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

PATH PARAMETERS

id : string

ファイルID (必須)

配信管理情報に登録済みの「ファイルID」を指定

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

製品バージョン

id : string

ファイルID

comment : string

コメント

file : object

配信ファイル

name : string

配信ファイル名

type : string

転送タイプ

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

format (F)

: フォーマットデータ

binary (B)

: バイナリデータ

text (T)

: テキストデータ

multiformat (M)

: マルチフォーマットデータ

treat : string

配信ファイルの扱い

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

keep (K)

: 配信中はロックを行わず、正常終了後ファイルを保存

clear (C)

: 配信中はロックを行い、正常終了後0バイトファイルになる

delete (D)

: 配信中はロックを行い、正常終了後ファイルを削除

lock (L)

: 配信中はロックを行い、正常終了後ファイルを保存

communication : object

通信設定

transfer_group : string

転送グループID

block_length : integer

転送ブロック長

block_count : integer

転送ブロック数

priority : integer

転送優先度

interval : integer

転送間隔

code_conversion : object

コード変換

side : string

コード変換側

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

sending (S)

: 配信側ホストで変換

receiving (R)

: 集信側ホストで変換

none (N)

: 変換せずに配信

ebcdic_set : string

EBCDICセット

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

auto (0)

: 自動

katakana (A)

: カナ文字

lowercase (B)

: 英小文字

ascii (C)

: ASCII

aspen (D)

: ASPEN

latin_ibm_japan (E)

: IBM英小文字

latin_extended_ibm_japan (F)

: IBM拡張

katakana_nec (G)

: NECカナ文字

katakana_extended_ibm_japan (H)

: IBMカナ文字拡張

simplified_extended_chinese (I)

: 中国語簡体字拡張

user_table_1 (V)

: ユーザテーブル1

user_table_2 (W)

: ユーザテーブル2

user_table_3 (X)

: ユーザテーブル3

shiftcode : string

MF-IBMi系機種とのコード変換

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

add (Y)

: シフトコードを付加する

none (N)

: シフトコードを付加しない

compression : object

圧縮設定

type : string

圧縮方式

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

none (N)

: 圧縮なし

horizontal (1)

: レコード内圧縮

vertical (2)

: レコード間圧縮

deflate (3)

: DEFLATE圧縮

zstandard (4)

: Zstandard圧縮

mode : string

圧縮モード

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

speed_priority (S)

: 圧縮速度優先

standard (D)

: 標準

ratio_priority (C)

: 圧縮率優先

unit : integer

圧縮単位

job : object

ジョブ起動設定

pre : string

配信前ジョブID

successful : string

正常時ジョブID

unsuccessful : string

異常時ジョブID

multiformat_id : string

マルチフォーマットID・フォーマットID

Security : object

セキュリティ設定

password : string <password>

暗号キー

database_id : string

連携DBID

以下の値が取得されます。

csv

: 集信側で集信ファイルをCSV形式変換する

windows : object

Windows環境管理情報

mail_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

詳細エラー情報

]