集信管理情報の取得
登録済みの集信管理情報を取得します。
Request Interface
http://ControlURL/api/v1/hulft/{hulft-host-id}/managements/receivings/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
- id : string
-
ファイルID
- 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
-
製品バージョン
- comment : string
-
コメント
- file : object
-
集信ファイル
- name : string
-
集信ファイル名
- owner : string
-
オーナー名
- group : string
-
グループ名
- permission : object
-
パーミッション
- owner : object
-
オーナー権限
- readable : boolean
-
読み込み権限
以下のいずれかが取得されます。
- false
-
: チェックしない
- true
-
: チェックする
- writable : boolean
-
書き込み権限
以下のいずれかが取得されます。
- false
-
: チェックしない
- true
-
: チェックする
- executable : boolean
-
実行権限
以下のいずれかが取得されます。
- false
-
: チェックしない
- true
-
: チェックする
- group : object
-
グループ権限
- readable : boolean
-
読み込み権限
以下のいずれかが取得されます。
- false
-
: チェックしない
- true
-
: チェックする
- writable : boolean
-
書き込み権限
以下のいずれかが取得されます。
- false
-
: チェックしない
- true
-
: チェックする
- executable : boolean
-
実行権限
以下のいずれかが取得されます。
- false
-
: チェックしない
- true
-
: チェックする
- other : object
-
その他のメンバー権限
- readable : boolean
-
読み込み権限
以下のいずれかが取得されます。
- false
-
: チェックしない
- true
-
: チェックする
- writable : boolean
-
書き込み権限
以下のいずれかが取得されます。
- false
-
: チェックしない
- true
-
: チェックする
- executable : boolean
-
実行権限
以下のいずれかが取得されます。
- false
-
: チェックしない
- true
-
: チェックする
- write_mode : string
-
保存時の動作
以下のいずれかが取得されます。
- new (N)
-
: 集信ファイルを新規に作成。同名のファイルがすでに存在している場合はエラー。
- replace (R)
-
: 既存のファイル内容を受信データに置き換え。ファイルが存在しない場合は新規に作成。
- append (M)
-
: 既存ファイルの最後に受信データを追加。ファイルが存在しない場合は新規に作成。
- abnormal_treat : string
-
異常時の処理
以下のいずれかが取得されます。
- delete (D)
-
: 集信ファイルを削除
- keep (K)
-
: 集信が失敗した時点の集信ファイルを保持
- recover (R)
-
: 集信開始前に集信ファイルをバックアップし、集信が失敗したらバックアップを復元 集信開始前に集信ファイルが存在しなかった場合は“delete”と同じ動作
- receive_mode : string
-
集信形態
以下のいずれかが取得されます。
- single (S)
-
: 単一ホストからファイルを集信
- multiple (M)
-
: 複数ホストからファイルを集信し、1つのファイルを作成
- generational_management : string
-
世代管理
以下のいずれかが取得されます。
- disable (N)
-
: 世代管理なし
- enable (Y)
-
: 世代管理あり
- number_of_generations : integer
-
世代数
- communication : object
-
通信設定
- transfer_group : string
-
転送グループID
- finish_sync_mode : string
-
配信側への集信完了通知
以下のいずれかが取得されます。
- eof (T)
-
: 受信完了後に通知
- job (J)
-
: 集信後正常時ジョブ完了後に通知
- code_conversion : object
-
コード変換
- 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
- job : object
-
ジョブ起動設定
- successful : string
-
正常時ジョブID
- unsuccessful : string
-
異常時ジョブID
- security : object
-
セキュリティ設定
- password : string <password>
-
暗号キー
- verify : string
-
データ検証
以下のいずれかが取得されます。
- none (0)
-
: データ検証を行わない
- md5 (1)
-
: データ検証を行う
- linux : object
-
Linux/AIX環境管理情報
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
-
詳細エラー情報
]