配信管理情報の登録および更新

配信管理情報を登録および更新します。

Examples

REQUEST EXAMPLE

サンプルは以下となります。

{
  "id": "LOOPBACK",
  "meta": {
    "display_name": "loopback",
    "comment": "sample comment",
    "valid_term": {
      "start": "2025-10-03T03:04:05+09:00",
      "end": "2025-10-04T03:04:05+09:00"
    },
    "accept_term": {
      "start": "03:04:05+09:00",
      "end": "04:04:05+09:00"
    }
  },
  "authorities": [
    {
      "type": "user",
      "name": "user_name",
      "role": "owner"
    }
  ],
  "file": {
    "name": "/tmp/snd/sample",
    "type": "text",
    "treat": "keep"
  },
  "code_conversion": {
    "side": "sending",
    "own_code_set": "system",
    "standard_for_japanese": "jis83",
    "ebcdic_set": "auto"
  },
  "communication": {
    "transfer_group": "GROUPID",
    "block_length": 0,
    "block_count": 0
  },
  "compression": {
    "type": "zstandard",
    "mode": "standard"
  },
  "job": {
    "pre": "PRE_JOB",
    "successful": "SUCCESS_JOB",
    "unsuccessful": "UNSUCCESSFUL_JOB"
  },
  "security": {
    "password_type": "ascii",
    "password": "paSSw0rd"
  }
}

Request Interface

https://ControlURL/api/v1/managements/sendings/detail

= 備考 =

WebAPIのControlURLで指定するパスはHULFTの管理画面にアクセスするためのURLと同じURLです。

詳細は以下を参照してください。

HULFT10 for Container Platform スタートアップガイド（OpenShift） : 「導入手順」の「HULFT管理画面の起動」

REQUEST BODY SCHEMA : application/json

id : string

ファイルID （必須）

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

英大文字数字、および“_”で指定します。

meta : object

メタ情報（必須）

display_name : string

表示名（必須）

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

comment : string

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

valid_term : object

管理情報の有効期間

start : string <date-time>

有効期間 (開始)

end : string <date-time>

有効期間 (終了)

「有効期間 (終了)」は「有効期間 (開始)」より後の時間を指定します。

accept_term : object

要求の受付時間帯

管理情報に対する要求を受付する時間帯

省略すると、管理情報の有効期間内のすべての日時で要求を受け付けます。

start : string: 受付時間帯 (開始) （必須）
end : string: 受付時間帯 (終了) （必須）

authorities : Array of objects

権限情報

最大権限情報数：100

以下の構造の情報（Array[]）を複数（～100）設定可能です。

Array[

type : string

ユーザーグループID/ユーザーID （必須）

管理情報に対する権限を保持している、ユーザーグループおよびユーザーのID

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

group: : ユーザーグループIDを、3バイトから255バイトの英数字、および半角スペース、“-”、“/”、“*”を除く記号で指定
user: : ユーザーIDを、1024バイト以内の英数字、および“/”を除く記号で指定

name : string

権限付与対象名（必須）

role : string

管理情報の権限（必須）

「ユーザーグループID」および「ユーザーID」の、管理情報に対する権限

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

owner: : 所有者（管理情報に対してすべての操作が可能なユーザー）
contributor: : 更新者（管理情報の情報を更新可能なユーザー）
executor: : 実行者（管理情報を使用して、転送を開始できるユーザー）
reader: : 閲覧者（管理情報を参照できるユーザー）
auditor: : 監視者（履歴だけを参照できるユーザー）

]

file : object

配信ファイル（必須）

name : string

配信ファイル名（必須）

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

type : string

転送タイプ（必須）

配信するファイルのデータタイプ

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

binary: : バイナリデータ
text: : テキストデータ

treat : string

配信ファイルの扱い

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

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

keep: : 保存（配信中は共有ロックを行い、正常終了後ファイルを保存）
clear: : クリア（配信中は排他ロックを行い、正常終了後0バイトファイルになる）
delete: : 削除（配信中は排他ロックを行い、正常終了後ファイルを削除）
lock: : ロック（配信中は排他ロックを行い、正常終了後ファイルを保存）

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

code_conversion : object

コード変換

省略すると、以下の値が設定されます。

side: sending
own_code_set: system
standard_for_japanese: system
ebcdic_set: auto

side : string

コード変換側（必須）

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

「転送タイプ」で“text”を指定した場合のみ、設定できます。

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

none: : 無変換（変換せずに配信）
sending: : 配信側（配信側ホストで変換）
receiving: : 集信側（集信側ホストで変換）

own_code_set : string

転送コードセット（必須）

自ホストの文字コード

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

system: : システム（システム動作環境設定の「転送コードセット」の設定値）
utf8: : UTF-8
sjis: : Shift-JIS
euc_jp: : EUC-JP
gb18030: : GB18030

standard_for_japanese : string

日本語規格（必須）

「転送コードセット」で指定した文字コードのJIS年度

日本語コード変換の場合のみ、設定値が有効となります。

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

system: : システム（システム動作環境設定の「日本語規格」の設定値）
jis83: : JIS83（JIS 83年度）
jis78: : JIS78（JIS 78年度）

ebcdic_set : string

相手ホストのEBCDICセット

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

配信側ホスト（相手ホスト）のEBCDICセットを指定します。

この設定は、配信側ホストがEBCDIC系コードセットで、「コード変換」が“receiving”の場合に有効です。

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

auto: : 自動
katakana: : カナ文字
lowercase: : 英小文字
ascii: : ASCII
japan_latin_for_ibm: : IBM英小文字
japan_latin_extended_for_ibm: : IBM英小文字拡張
japan_katakana_extended_for_ibm: : IBMカナ文字拡張

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

communication : object

通信設定（必須）

transfer_group : string

転送グループID

配信するファイルの配信先が登録されているID

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

英数字、および“_”で指定します。

block_length : integer

転送ブロック長

1ブロックを転送するときの長さ

0バイト、または128バイトから65520バイトまでの値で指定します。

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

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

block_count : integer

転送ブロック数

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

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

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

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

compression : object

圧縮設定（必須）

type : string

圧縮方式（必須）

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

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

none: : 圧縮なし
deflate: : DEFLATE圧縮
zstandard: : Zstandard圧縮

mode : string

圧縮モード

DEFLATE圧縮時またはZstandard圧縮時に使用する圧縮モード

圧縮方式で“deflate”または“zstandard”を選択した場合に設定できます。

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

standard: : 標準（標準モード）
speed_priority: : 圧縮速度優先（圧縮速度を優先するモード）
ratio_priority: : 圧縮率優先（圧縮率を優先するモード）

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

job : object

ジョブ起動設定

pre : string

配信前ジョブID

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

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

英数字、および“_”で指定します。

successful : string

正常時ジョブID

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

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

英数字、および“_”で指定します。

unsuccessful : string

異常時ジョブID

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

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

英数字、および“_”で指定します。

security : object

セキュリティ設定

password_type : string

暗号キーの種類

データを暗号化するキーの種類

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

ascii: : データを暗号化するキーを8バイトから20バイトの英数字で指定
hex: : データを暗号化するキーを16桁から40桁の16進数で指定

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

password : string <password>

暗号キー

Response Interface

200 既存管理情報の更新に成功

RESPONSE HEADERS

X-Request-ID : string: WebAPI履歴のリクエストID

RESPONSE SCHEMA : application/json

id : string

ファイルID

meta : object

メタ情報

modified_datetime : string <date-time>

更新日時

modified_user : string

更新ユーザー

request_user : object

ロール情報

systems_role : string: APIを実行したユーザーの「ユーザーの権限」
managements_id_role : string: APIを実行したユーザーの「管理情報の権限」

display_name : string

表示名

comment : string

valid_term : object

管理情報の有効期間

start : string <date-time>: 有効期間 (開始)
end : string <date-time>: 有効期間 (終了)

accept_term : object

要求の受付時間帯

start : string: 受付時間帯 (開始)
end : string: 受付時間帯 (終了)

authorities : Array of objects

権限情報

以下の構造の情報（Array[]）が複数（～100）取得されます。

Array[

type : string

ユーザーグループID/ユーザーID

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

group: : ユーザーグループIDを、3バイトから255バイトの英数字、および半角スペース、“-”、“/”、“*”を除く記号で指定
user: : ユーザーIDを、1024バイト以内の英数字、および“/”を除く記号で指定

name : string

権限付与対象名

role : string

管理情報の権限

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

owner: : 所有者（管理情報に対してすべての操作が可能なユーザー）
contributor: : 更新者（管理情報の情報を更新可能なユーザー）
executor: : 実行者（管理情報を使用して、転送を開始できるユーザー）
reader: : 閲覧者（管理情報を参照できるユーザー）
auditor: : 監視者（履歴だけを参照できるユーザー）

]

file : object

配信ファイル

name : string

配信ファイル名

type : string

転送タイプ

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

binary: : バイナリデータ
text: : テキストデータ

treat : string

配信ファイルの扱い

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

keep: : 保存（配信中は共有ロックを行い、正常終了後ファイルを保存）
clear: : クリア（配信中は排他ロックを行い、正常終了後0バイトファイルになる）
delete: : 削除（配信中は排他ロックを行い、正常終了後ファイルを削除）
lock: : ロック（配信中は排他ロックを行い、正常終了後ファイルを保存）

code_conversion : object

コード変換

side : string

コード変換側

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

none: : 無変換（変換せずに配信）
sending: : 配信側（配信側ホストで変換）
receiving: : 集信側（集信側ホストで変換）

own_code_set : string

転送コードセット

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

system: : システム（システム動作環境設定の「転送コードセット」の設定値）
utf8: : UTF-8
sjis: : Shift-JIS
euc_jp: : EUC-JP
gb18030: : GB18030

standard_for_japanese : string

日本語規格

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

system: : システム（システム動作環境設定の「日本語規格」の設定値）
jis83: : JIS83（JIS 83年度）
jis78: : JIS78（JIS 78年度）

ebcdic_set : string

相手ホストのEBCDICセット

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

auto: : 自動
katakana: : カナ文字
lowercase: : 英小文字
ascii: : ASCII
japan_latin_for_ibm: : IBM英小文字
japan_latin_extended_for_ibm: : IBM英小文字拡張
japan_katakana_extended_for_ibm: : IBMカナ文字拡張

communication : object

通信設定

transfer_group : string: 転送グループID
block_length : integer: 転送ブロック長
block_count : integer: 転送ブロック数

compression : object

圧縮設定

type : string

圧縮方式

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

none: : 圧縮なし
deflate: : DEFLATE圧縮
zstandard: : Zstandard圧縮

mode : string

圧縮モード

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

standard: : 標準（標準モード）
speed_priority: : 圧縮速度優先（圧縮速度を優先するモード）
ratio_priority: : 圧縮率優先（圧縮率を優先するモード）

job : object

ジョブ起動設定

pre : string: 配信前ジョブID
successful : string: 正常時ジョブID
unsuccessful : string: 異常時ジョブID

security : object

セキュリティ設定

password_type : string

暗号キーの種類

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

ascii: : データを暗号化するキーを8バイトから20バイトの英数字で指定
hex: : データを暗号化するキーを16桁から40桁の16進数で指定

password : string <password>

暗号キー

201 新規管理情報の登録に成功

RESPONSE HEADERS

X-Request-ID : string: WebAPI履歴のリクエストID
Location : string: 作成されたリソースのパス

RESPONSE SCHEMA : application/json

id : string

ファイルID

meta : object

メタ情報

modified_datetime : string <date-time>

更新日時

modified_user : string

更新ユーザー

request_user : object

ロール情報

systems_role : string: APIを実行したユーザーの「ユーザーの権限」
managements_id_role : string: APIを実行したユーザーの「管理情報の権限」

display_name : string

表示名

comment : string

valid_term : object

管理情報の有効期間

start : string <date-time>: 有効期間 (開始)
end : string <date-time>: 有効期間 (終了)

accept_term : object

要求の受付時間帯

start : string: 受付時間帯 (開始)
end : string: 受付時間帯 (終了)

authorities : Array of objects

権限情報

以下の構造の情報（Array[]）が複数（～100）取得されます。

Array[

type : string

ユーザーグループID/ユーザーID

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

group: : ユーザーグループIDを、3バイトから255バイトの英数字、および半角スペース、“-”、“/”、“*”を除く記号で指定
user: : ユーザーIDを、1024バイト以内の英数字、および“/”を除く記号で指定

name : string

権限付与対象名

role : string

管理情報の権限

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

owner: : 所有者（管理情報に対してすべての操作が可能なユーザー）
contributor: : 更新者（管理情報の情報を更新可能なユーザー）
executor: : 実行者（管理情報を使用して、転送を開始できるユーザー）
reader: : 閲覧者（管理情報を参照できるユーザー）
auditor: : 監視者（履歴だけを参照できるユーザー）

]

file : object

配信ファイル

name : string

配信ファイル名

type : string

転送タイプ

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

binary: : バイナリデータ
text: : テキストデータ

treat : string

配信ファイルの扱い

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

keep: : 保存（配信中は共有ロックを行い、正常終了後ファイルを保存）
clear: : クリア（配信中は排他ロックを行い、正常終了後0バイトファイルになる）
delete: : 削除（配信中は排他ロックを行い、正常終了後ファイルを削除）
lock: : ロック（配信中は排他ロックを行い、正常終了後ファイルを保存）

code_conversion : object

コード変換

side : string

コード変換側

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

none: : 無変換（変換せずに配信）
sending: : 配信側（配信側ホストで変換）
receiving: : 集信側（集信側ホストで変換）

own_code_set : string

転送コードセット

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

system: : システム（システム動作環境設定の「転送コードセット」の設定値）
utf8: : UTF-8
sjis: : Shift-JIS
euc_jp: : EUC-JP
gb18030: : GB18030

standard_for_japanese : string

日本語規格

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

system: : システム（システム動作環境設定の「日本語規格」の設定値）
jis83: : JIS83（JIS 83年度）
jis78: : JIS78（JIS 78年度）

ebcdic_set : string

相手ホストのEBCDICセット

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

auto: : 自動
katakana: : カナ文字
lowercase: : 英小文字
ascii: : ASCII
japan_latin_for_ibm: : IBM英小文字
japan_latin_extended_for_ibm: : IBM英小文字拡張
japan_katakana_extended_for_ibm: : IBMカナ文字拡張

communication : object

通信設定

transfer_group : string: 転送グループID
block_length : integer: 転送ブロック長
block_count : integer: 転送ブロック数

compression : object

圧縮設定

type : string

圧縮方式

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

none: : 圧縮なし
deflate: : DEFLATE圧縮
zstandard: : Zstandard圧縮

mode : string

圧縮モード

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

standard: : 標準（標準モード）
speed_priority: : 圧縮速度優先（圧縮速度を優先するモード）
ratio_priority: : 圧縮率優先（圧縮率を優先するモード）

job : object

ジョブ起動設定

pre : string: 配信前ジョブID
successful : string: 正常時ジョブID
unsuccessful : string: 異常時ジョブID

security : object

セキュリティ設定

password_type : string

暗号キーの種類

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

ascii: : データを暗号化するキーを8バイトから20バイトの英数字で指定
hex: : データを暗号化するキーを16桁から40桁の16進数で指定

password : string <password>

暗号キー

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)) or (Error3(object or null))

"Error1"、"Error2"、"Error3"のいずれかが取得されます。

Error1

message : string: エラーメッセージ
tables : Array of strings: テーブル情報
query : string: クエリ情報

Error2

hulft_id : string: HULFT ID
code : integer: 実行結果
detail : integer: 詳細コード
message : string: エラーメッセージ

Error3

message : string: エラーメッセージ
fields : string: クエリ情報

]

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

詳細エラー情報

additional : (Error1(object or null)) or (Error2(object or null)) or (Error3(object or null))

"Error1"、"Error2"、"Error3"のいずれかが取得されます。

Error1

message : string: エラーメッセージ
tables : Array of strings: テーブル情報
query : string: クエリ情報

Error2

hulft_id : string: HULFT ID
code : integer: 実行結果
detail : integer: 詳細コード
message : string: エラーメッセージ

Error3

message : string: エラーメッセージ
fields : string: クエリ情報

]