集信管理情報の登録

集信管理情報を登録します。

Examples

REQUEST EXAMPLE

HULFT for Linux/AIX のサンプルは以下となります。

{
  "id": "FILEID",
  "comment": "コメント",
  "file": {
    "name": "/root/testfile/rcv",
    "owner": "root",
    "group": "root",
    "permission": {
      "owner": {
        "readable": true,
        "writable": true,
        "executable": false
      },
      "group": {
        "readable": true,
        "writable": true,
        "executable": false
      },
      "other": {
        "readable": true,
        "writable": true,
        "executable": false
      }
    },
    "write_mode": "replace",
    "abnormal_treat": "delete",
    "receive_mode": "single",
    "generational_management": "enable",
    "number_of_generations": 2
  },
  "communication": {
    "transfer_group": "LOOPBACK",
    "finish_sync_mode": "eof"
  },
  "code_conversion": {
    "ebcdic_set": "auto"
  },
  "job": {
    "successful": "SUCCJOB",
    "unsuccessful": "FAILJOB"
  },
  "security": {
    "password": "00000000",
    "verify": "none"
  }
}

Request Interface

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

= 備考 =

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

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

REQUEST BODY SCHEMA : application/json

id : string

ファイルID （必須）

集信するファイルを認識するためのID

1～50バイト以内で指定します。

comment : string

集信するファイルに対するコメント

0～60バイト以内で指定します。

file : object

集信ファイル（必須）

name : string

集信ファイル名（必須）

Windows上に格納されている集信ファイル

絶対パスで指定します。

1～200バイト以内で指定します。

Serverグレードを導入した環境では、ネットワーク資源を利用したファイルを指定できます。

owner : string

オーナー名

14バイト以内で指定します。

システムに登録されている所有者名を設定してください。

group : string

グループ名

14バイト以内で指定します。

システムに登録されているグループ名を設定してください。

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): : 既存ファイルの最後に受信データを追加。ファイルが存在しない場合は新規に作成。

「集信形態」が“single”で「保存時の動作」に“append”を指定した場合、集信中に何らかの異常が発生すると、異常が発生する前までの集信データは追加書きされてしまいます。

abnormal_treat : string

異常時の処理（必須）

集信に失敗したときの集信ファイルの処理

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

delete (D): : 集信ファイルを削除
keep (K): : 集信が失敗した時点の集信ファイルを保持
recover (R): : 集信開始前に集信ファイルをバックアップし、集信が失敗したらバックアップを復元集信開始前に集信ファイルが存在しなかった場合は“delete”と同じ動作

receive_mode : string

集信形態（必須）

集信するファイルの集信形態

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

single (S): : 単一ホストからファイルを集信
multiple (M): : 複数ホストからファイルを集信し、1つのファイルを作成

“multiple”を指定する場合、「保存時の動作」に“append”を、「異常時の処理」に“keep”を指定してください。

generational_management : string

世代管理（必須）

集信ファイルの世代管理の有無

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

disable (N): : 世代管理なし
enable (Y): : 世代管理あり

“enable”を指定する場合、以下のように指定してください。

「保存時の動作」に“new”または“replace”を指定
「異常時の処理」に“delete”を指定

number_of_generations : integer

世代数

集信ファイルの世代数

2～9999バイト以内で指定します。

「世代管理」に“enable”を指定した場合のみ、設定値が有効になります。

communication : object

通信設定

transfer_group : string

転送グループID

1～50バイト以内で指定します。

finish_sync_mode : string

配信側への集信完了通知

配信側ホストへの集信完了通知

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

eof (T): : 受信完了後に通知
job (J): : 集信後正常時ジョブ完了後に通知

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

code_conversion : object

コード変換

ebcdic_set : string

EBCDICセット

1バイトコードを変換するときに使用するEBCDIC系コードセット

配信側ホストの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

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

この設定は、配信側ホストがMF-IBMi系機種で集信側変換の場合に有効です。

job : object

ジョブ起動設定

successful : string

正常時ジョブID

ファイルの配信が正常終了したときに起動するジョブID

0～50バイト以内で指定します。

英数字および“_（アンダースコア）”が使用可能。

省略すると、ジョブは起動されません。

unsuccessful : string

異常時ジョブID

ファイルの配信が異常終了したときに起動するジョブID

0～50バイト以内で指定します。

英数字および“_（アンダースコア）”が使用可能。

省略すると、ジョブは起動されません。

security : object

セキュリティ設定

password : string <password>

暗号キー

データを暗号化するキー

相手ホストの配信管理情報に設定されている暗号キーと同じ暗号キーを設定してください。

暗号キーが不一致の場合、データは正しく復号されません。

0～64バイト以内で指定します。

システム動作環境設定の「高強度暗号強制モード」の設定により動作が変わります。

高強度暗号強制モードが無効な場合

8バイト以上20バイト以内の英数字で指定してください。
集信側で「暗号キー」が指定されていても配信側の配信管理情報で「暗号キー」が指定されていないと、集信側の「暗号キー」の設定は無視されます。

高強度暗号強制モードが有効な場合

64桁の16進文字列で指定してください。
暗号キーは必須指定です。

verify : string

データ検証

集信するファイルに対するデータ検証の有無

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

none (0): : データ検証を行わない
md5 (1): : データ検証を行う

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

linux : object

Linux/AIX環境管理情報

予約領域

Response Interface

201 Created 情報登録

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環境管理情報

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

]

409 登録済みの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: 詳細エラー情報

]