集信管理情報の更新

登録済みの集信管理情報を更新します。

Examples

REQUEST EXAMPLE

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

{
  "id": "FILEID",
  "comment": "UPDATEDCOMMENT",
  "file": {
    "write_mode": "new",
    "abnormal_treat": "keep"
  },
  "communication": {
    "finish_sync_mode": "job"
  },
  "code_conversion": {
    "ebcdic_set": "ascii"
  },
  "job": {
    "successful": "UPDATEDSUCCJOB"
  },
  "security": {
    "password": "11111111"
  }
}

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」を指定

REQUEST BODY SCHEMA : application/json

id : string

ファイルID

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

50バイト以内の英数字で指定します。

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

comment : string

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

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

file : object

集信ファイル

name : string

データセット名

集信ファイルのデータ・セット名

Mainframeのデータ・セット名の命名規約に従って指定します。

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

write_mode : string

保存時の動作

集信するファイルの保存時の動作

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

new (N): : 集信ファイルを新規に作成。同名のファイルがすでに存在している場合はエラー。
replace (R): : 既存のファイル内容を受信データに置き換え。ファイルが存在しない場合は新規に作成。
append (M): : 既存ファイルの最後に受信データを追加。ファイルが存在しない場合は新規に作成。

abnormal_treat : string

異常時の処理

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

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

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

「ボリュームの割り当て」が“multi”の場合、“recover”は指定できません。

ファイル転送が終わって集信処理が完了するまでの間に異常が発生しても、ファイルの転送は完了しているため、この指定は無視されます。

receive_mode : string

集信形態

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

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

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

catalog_operation : string

カタログ処理

集信ファイルのカタログ管理方法

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

none (N): : カタログなし
generational_management (Y): : 世代管理
catalog (C): : カタログする

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

communication : object

通信設定

transfer_group : string

転送グループID

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

block_length : integer

ブロック長

集信ファイルのブロック長

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

「レコード形式」が“fix”の場合は「レコード長」の整数倍の値を、“var”の場合は「レコード長」に4を足した値以上の整数を指定してください。

省略すると、「レコード形式」が“fix”の場合は「レコード長」と同じ値、“var”の場合は「レコード長」に4を足した値が設定されます。

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ｶﾅ文字拡張
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バイト以内で指定します。

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

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

「集信形態」が“multiple”の場合、指定する必要があります。

unsuccessful : string

異常時ジョブID

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

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

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

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

security : object

セキュリティ設定

password : string <password>

暗号キー

データを暗号化するキー

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

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

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

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

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

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

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

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

verify : string

データ検証

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

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

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

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

zos : object

z/OS（汎用機）環境管理情報

data_set : object

データセット情報

volume : string

ボリューム通番

集信ファイルが格納されているボリューム通番

Mainframeのボリューム通番の命名規約に従って指定します。

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

「ボリュームの割り当て」が“multi”の場合、「ボリューム通番」は指定できません。

work_volume : string

ワークボリューム通番

複数集信時の集信ワークファイルの格納ボリューム通番

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

省略すると、集信ファイルと同じボリュームに集信ワークファイルを作成します。

unit : string

UNIT名

集信ファイルを格納するUNIT名

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

secondary : integer

増分量

集信ファイルの増分量

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

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

first_extent : integer

一次要求量

集信ファイルの一次要求量

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

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

capacity : string

スペース単位

集信ワークファイルのスペース単位

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

cylinder (C): : シリンダー
track (T): : トラック

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

sequence_number : integer

順序番号

集信ファイルを格納するテープ装置ボリューム上の順序番号

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

省略する場合は“0”を指定してください。

receiving_with_rdw : string

RDW付加集信

転送データにレコード長領域（RDW）を付加するかどうかの設定

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

yes (Y): : RDW付き集信
no (N): : RDWなし集信

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

RDW付加集信を行う場合は、転送タイプに“binary”を指定します。

「レコード形式」が“fix”の場合、“yes”は指定できません。

unused_area : string

未使用域

集信ファイルの未使用域の処理

以下の値を指定します。

release (RLSE): : 解放する

省略すると、未使用域は解放しません。

multivolume : string

ボリュームの割り当て

集信ファイルのボリュームへの割り当て方法

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

single (S): : 単一ボリューム
multi (M): : マルチボリューム
auto (A): : 単一ボリュームかマルチボリュームか自動選択

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

print_character : string

印刷文字

印刷形式のファイルの選択

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

ansi (A): : ANSI制御文字
machine (M): : 機械制御文字

省略すると、印刷形式のファイルとなりません。

between_mainframe_attribute : string

汎用機間集信属性

集信ファイルの属性選択

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

sending (S): : 配信ファイルの属性を使用
receiving (R): : 集信管理情報の属性を使用

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

「汎用機間集信属性」に“sending”を指定し、かつ「データクラス」が指定されていない場合は、以下の項目をすべて登録する必要があります。

レコード形式
レコード長
ブロック長
スペース単位
一次要求量
増分量

なお、配信ファイルの属性を使用したい場合、すべての項目を以下の値で指定してください。

レコード形式 : “”（空文字）
レコード長 : “0”
ブロック長 : “0”
スペース単位 : “”（空文字）
一次要求量 : “0”
増分量 : “0”

record : object

レコード情報

length : integer

レコード長

集信ファイルのレコード長

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

format : string

レコード形式

集信ファイルのレコード形式

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

fix (F): : 固定長
var (V): : 可変長

RDW付加集信を行う場合は、“var”を指定してください。

class : object

クラス情報

storage_class : string

ストレージクラス

パフォーマンスと可用性要件を指定するデータ・セット・ストレージ・サービス属性の名前付きリスト

SMSは、この属性を使用してデータ配置を制御します。

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

management_class : string

管理クラス

システムがデータ・セット・レベルでストレージを管理するために使用する、データ・セットのマイグレーション、バック

アップ、保存期間属性のリスト

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

data_class : string

データクラス

システムがデータ・セットの作成用に使用する割り振り属性のリスト

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

「ストレージクラス」、「管理クラス」、「データクラス」のいずれかが設定された場合、集信プログラムの実行パラメータで“SMS”を指定した場合と同様の動作を行います。

「データクラス」を指定する場合、OSの「データ・クラス属性」の値を使用することが可能です。

OSのデータ・クラス属性の値を使用したい場合、該当する項目を以下の値で指定してください。

レコード形式 : “”（空文字）
レコード長 : “0”
ブロック長 : “0”
スペース単位 : “”（空文字）
一次要求量 : “0”
増分量 : “0”

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

データセット名

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つのファイルを作成

catalog_operation : string

カタログ処理

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

none (N): : カタログなし
generational_management (Y): : 世代管理
catalog (C): : カタログする

communication : object

通信設定

transfer_group : string

転送グループID

block_length : integer

ブロック長

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ｶﾅ文字拡張
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): : データ検証を行う

zos : object

z/OS（汎用機）環境管理情報

data_set : object

データセット情報

volume : string

ボリューム通番

work_volume : string

ワークボリューム通番

unit : string

UNIT名

secondary : integer

増分量

first_extent : integer

一次要求量

capacity : string

スペース単位

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

cylinder (C): : シリンダー
track (T): : トラック

sequence_number : integer

順序番号

receiving_with_rdw : string

RDW付加集信

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

yes (Y): : RDW付き集信
no (N): : RDWなし集信

unused_area : string

未使用域

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

release (RLSE): : 解放する

multivolume : string

ボリュームの割り当て

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

single (S): : 単一ボリューム
multi (M): : マルチボリューム
auto (A): : 単一ボリュームかマルチボリュームか自動選択

print_character : string

印刷文字

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

ansi (A): : ANSI制御文字
machine (M): : 機械制御文字

between_mainframe_attribute : string

汎用機間集信属性

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

sending (S): : 配信ファイルの属性を使用
receiving (R): : 集信管理情報の属性を使用

record : object

レコード情報

length : integer

レコード長

format : string

レコード形式

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

fix (F): : 固定長
var (V): : 可変長

class : object

クラス情報

storage_class : string: ストレージクラス
management_class : string: 管理クラス
data_class : string: データクラス

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

]

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

]