配信管理情報の一覧取得

登録済みの配信管理情報の一覧を取得します。

「QUERY PARAMETERS」で指定された内容に基づき、該当する配信管理情報を取得します。

指定方法については、以下の例を参照してください。

例1)

全件取得したい場合

  • パラメータ「limit」に登録済みの配信管理情報の件数以上の値を指定

例2)

管理情報の有効期間が「2025/10/1~2026/3/31」の管理情報を「ファイルID」の「昇順」で取得したい場合

  • パラメータ「order-column」に「id」を指定

  • パラメータ「order」に「asc」を指定

  • パラメータ「from-valid-term-start」に「2025-10-01T00:00:00%2B09:00」を指定

  • パラメータ「to-valid-term-start」に「2025-10-02T00:00:00%2B09:00」を指定

  • パラメータ「from-valid-term-end」に「2026-03-31T00:00:00%2B09:00」を指定

  • パラメータ「to-valid-term-end」に「2026-04-01T00:00:00%2B09:00」を指定

Request Interface

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

= 備考 =

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

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

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

QUERY PARAMETERS

limit : integer

検索件数の上限

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

offset : integer

検索結果のオフセット

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

order-column : string

並び替え

検索結果の並び替えを行うフィールド

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

order : string

並び替え

検索結果の並び替え順序

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

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

asc

: 昇順

desc

: 降順

id : string

ファイルID

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

modified-datetime : string <date-time>

管理情報の更新日時

from-modified-datetime : string <date-time>

管理情報の更新日時の範囲指定

指定した日時以後を表示

to-modified-datetime : string <date-time>

管理情報の更新日時の範囲指定

指定した日時以前を表示

modified-user : string

更新ユーザー

display-name : string

表示名

comment : string

コメント

valid-term-start : string <date-time>

管理情報の有効期間(開始)

from-valid-term-start : string <date-time>

管理情報の有効期間(開始)の範囲指定

指定した日時以後を表示

to-valid-term-start : string <date-time>

管理情報の有効期間(開始)の範囲指定

指定した日時以前を表示

valid-term-end : string <date-time>

管理情報の有効期間(終了)

from-valid-term-end : string <date-time>

管理情報の有効期間(終了)の範囲指定

指定した日時以後を表示

to-valid-term-end : string <date-time>

管理情報の有効期間(終了)の範囲指定

指定した日時以前を表示

accept-term-start : string

配信管理情報に対する要求を受付する時間帯(開始)

accept-term-end : string

配信管理情報に対する要求を受付する時間帯(終了)

file-name : string

配信ファイル名

file-type : string

転送タイプ

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

binary

: バイナリデータ

text

: テキストデータ

compression-type : string

圧縮方式

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

none

: 圧縮なし

deflate

: DEFLATE圧縮

zstandard

: Zstandard圧縮

compression-mode : string

圧縮モード

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

standard

: 標準(標準モード)

speed_priority

: 圧縮速度優先(圧縮速度を優先するモード)

ratio_priority

: 圧縮率優先(圧縮率を優先するモード)

code-conversion-side : string

コード変換側

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

none

: 無変換(変換せずに配信)

sending

: 配信側(配信側ホストで変換)

receiving

: 集信側(集信側ホストで変換)

code-conversion-own-code-set : string

転送コードセット

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

system

: システム(システム動作環境設定の「転送コードセット」の設定値)

utf8

: UTF-8

sjis

: Shift-JIS

euc_jp

: EUC-JP

gb18030

: GB18030

code-conversion-standard-for-japanese : string

日本語規格

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

system

: システム(システム動作環境設定の「日本語規格」の設定値)

jis83

: JIS83(JIS 83年度)

jis78

: JIS78(JIS 78年度)

file-treat : string

配信ファイルの扱い

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

keep

: 保存(配信中は共有ロックを行い、正常終了後ファイルを保存)

clear

: クリア(配信中は排他ロックを行い、正常終了後0バイトファイルになる)

delete

: 削除(配信中は排他ロックを行い、正常終了後ファイルを削除)

lock

: ロック(配信中は排他ロックを行い、正常終了後ファイルを保存)

communication-transfer-group : string

転送グループID

job-pre : string

配信前ジョブID

job-successful : string

正常時ジョブID

job-unsuccessful : string

異常時ジョブID

communication-block-length : integer

転送ブロック長

communication-block-count : integer

転送ブロック数

Response Interface

200 管理情報一覧の取得に成功

RESPONSE HEADERS

X-Request-ID : string

WebAPI履歴のリクエストID

RESPONSE SCHEMA : application/json

meta : object

メタ情報

total : integer

検索条件に一致するレコードの総数

request_user : object

ロール情報

systems_role : string

APIを実行したユーザーの「ユーザーの権限」

records : Array of objects

検索結果に一致するレコードのうちオフセットからリミットまで取り出したもの

以下の構造の情報(Array[])が複数取得されます。

Array[

id : string

ファイルID

meta : object

メタ情報

modified_datetime : string <date-time>

更新日時

modified_user : string

更新ユーザー

display_name : string

表示名

comment : string

コメント

valid_term : object

管理情報の有効期間

start : string <date-time>

有効期間 (開始)

end : string <date-time>

有効期間 (終了)

accept_term : object

要求の受付時間帯

start : string

受付時間帯 (開始)

end : string

受付時間帯 (終了)

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

]

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

クエリ情報

]