配信管理情報の登録

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

Examples

REQUEST EXAMPLE

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

{
  "id": "FILEID",
  "comment": "コメント",
  "file": {
    "name": "TEST/TESTFILE",
    "type": "binary",
    "treat": "keep"
  },
  "communication": {
    "transfer_group": "LOOPBACK",
    "block_length": 128,
    "block_count": 99,
    "priority": 1,
    "interval": 100
  },
  "code_conversion": {
    "side": "sending",
    "ebcdic_set": "auto",
    "shiftcode": "space",
    "end_character_cut": "none"
  },
  "compression": {
    "type": "deflate",
    "mode": "standard"
  },
  "job": {
    "pre": "PREJOB",
    "successful": "SUCCJOB",
    "unsuccessful": "FAILJOB"
  },
  "security": {
    "password": "PASSWORD"
  }
}

Request Interface

http://ControlURL/api/v1/hulft/{hulft-host-id}/managements/sendings/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

配信ファイル名（必須）

IBM i上に格納されているファイル

物理データファイルの場合は「ライブラリ名/ファイル名(メンバ名)」の形式で指定します。

保管ファイルの場合は「ライブラリ名/ファイル名」の形式で指定します。

3～33バイト以内で指定します。

配信ファイル名に「*FIRST」や「*FILE」などの予約語を用いた指定はできません。指定した場合は予期せぬ動作をすることがあります。

「転送タイプ」に“binary”を指定した場合のみ、保管ファイルを指定できます。

type : string

転送タイプ（必須）

配信するファイルの転送データ形式

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

format (F): : フォーマットデータ
binary (B): : バイナリデータ
text (T): : テキストデータ
multiformat (M): : マルチフォーマットデータ

treat : string

配信ファイルの扱い

配信ファイルの配信中の排他制御と、正常終了したときの処置

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

keep (K): : 配信中はロックを行わず、正常終了後ファイルを保存
clear (C): : 配信中はロックを行い、正常終了後0バイトファイルになる
delete (D): : 配信中はロックを行い、正常終了後ファイルを削除
lock (L): : 配信中はロックを行い、正常終了後ファイルを保存

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

communication : object

通信設定（必須）

transfer_group : string

転送グループID （必須）

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

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

block_length : integer

転送ブロック長

一度に転送するブロック長

単位は、バイトです。

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

“0”または128~65520までの値が指定可能。

転送ブロック長と転送ブロック数の積が65520を超える値は指定できません。

block_count : integer

転送ブロック数

一度に転送するブロック数

0～99の値を指定します。

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

転送ブロック長と転送ブロック数の積が65520を超える値は指定できません。

priority : integer

転送優先度

ファイルを転送するときの待ち行列での優先度

1～256の値を指定します。

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

優先度は、小さい数字ほど高くなります。

interval : integer

転送間隔

1ブロックの転送後から次の1ブロックの転送を開始するまでの間隔

単位は、ミリ秒です。

0～32767の値を指定します。

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

code_conversion : object

コード変換（必須）

side : string

コード変換側（必須）

配信するファイルのコード変換側の指定

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

sending (S): : 配信側ホストで変換
receiving (R): : 集信側ホストで変換
none (N): : 変換せずに配信

ebcdic_set : string

EBCDICセット

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

自ホストの転送コードセットがEBCDIC系コードセットの場合、配信側（自ホスト）のEBCDICセットを指定します。

自ホストの転送コードセットがUTF-8の場合、集信側（相手ホスト）の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”が設定されます。

shiftcode : string

Win-UX系機種とのコード変換

Win-UX系機種とコード変換を行うときのシフトコードの扱い

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

cut (C): : シフトコードを削除しデータを詰めた形に変換
space (S): : シフトコードをスペースに変換

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

end_character_cut : string

後続文字カット

配信ファイルから読み込んだデータの、後続のスペースの扱い

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

spaces (S): : 後続のスペースをカットする
none (N): : 後続のスペースをカットしない

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

転送タイプが“text”の場合のみ指定できます。

compression : object

圧縮設定（必須）

type : string

圧縮方式（必須）

ファイルを転送するときの圧縮の種類

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

none (N): : 圧縮なし
horizontal (1): : レコード内圧縮
vertical (2): : レコード間圧縮
deflate (3): : DEFLATE圧縮

mode : string

圧縮モード

DEFLATE圧縮時に使用する圧縮モード

圧縮方式で“deflate”を指定した場合のみ、設定できます。

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

speed_priority (S): : 圧縮速度優先
standard (D): : 標準
ratio_priority (C): : 圧縮率優先

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

job : object

ジョブ起動設定

pre : string

配信前ジョブID

配信を行う前に起動するジョブID

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

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

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

successful : string

正常時ジョブID

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

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

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

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

unsuccessful : string

異常時ジョブID

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

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

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

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

multiformat_id : string

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

配信するファイルのフォーマットまたはマルチフォーマットが登録されているID

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

転送タイプが“format”の場合は「フォーマットID」、転送タイプが“multiformat”の場合は「マルチフォーマットID」が必須です。

Security : object

セキュリティ設定

password : string <password>

暗号キー

データを暗号化するキー

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

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

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

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

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

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

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

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

database_id : string

連携DBID

配信されたデータの集信側での連携

以下の値を指定します。

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

集信側（Linux、AIX、およびWindows）で集信ファイルをCSV形式受信する場合、“csv”を指定します。

省略すると、CSV形式受信は行われません。

連携する場合は、転送タイプに“format”または“multiformat”を指定してください。

ibmi : object

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

予約領域

Response Interface

201 Created 情報登録

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

Win-UX系機種とのコード変換

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

cut (C): : シフトコードを削除しデータを詰めた形に変換
space (S): : シフトコードをスペースに変換

end_character_cut : string

後続文字カット

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

spaces (S): : 後続のスペースをカットする
none (N): : 後続のスペースをカットしない

compression : object

圧縮設定

type : string

圧縮方式

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

none (N): : 圧縮なし
horizontal (1): : レコード内圧縮
vertical (2): : レコード間圧縮
deflate (3): : DEFLATE圧縮

mode : string

圧縮モード

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

speed_priority (S): : 圧縮速度優先
standard (D): : 標準
ratio_priority (C): : 圧縮率優先

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形式変換する

ibmi : object

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

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

]