# 配信管理情報の取得

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

## Request Interface

    https://ControlURL/api/v1/managements/sendings/detail/{id}

= 備考 =

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

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

スタートアップガイド（EC2）

  : 導入手順

スタートアップガイド（Fargate）

  : 導入手順

PATH PARAMETERS

id : string

  ファイルID （必須）

  登録済みIDを指定

QUERY PARAMETERS

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

  更新日付

## 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>

    暗号キー

### 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

        クエリ情報

  ]

### 404 指定したIDまたは参照先の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

    詳細エラー情報

  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

        クエリ情報

  ]