# フォーマット情報の取得

登録済みのフォーマット情報を取得します。

## Request Interface

    http://ControlURL/api/v1/hulft/{hulft-host-id}/managements/formats/detail/{id}

= 備考 =

上のRequest InterfaceのURLで、斜体の文字部分に指定するパスについては以下を参照してください。

HULFT10 API Gateway ガイド : Request Interfaceの指定

PATH PARAMETERS

id : string

  フォーマットID （必須）

  フォーマット情報に登録済みの「フォーマットID」を指定

## Response Interface

### 200 OK

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

  コメント

formats : Array of objects

  フォーマット

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

  Array[

  field_name : string

    項目名

  start_position : integer

    開始位置

  bytes_count : integer

    バイト数

  decimal_places : integer

    小数部桁数

  field_type : string

    項目タイプ

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

    character (X)

      : キャラクタ。EBCDICコードのみの文字データ形式。2バイトコードが含まれていてはいけません。

    binary (B)

      : バイナリ。符号付きの整数の数値データ形式。

    signed_internal_decimal (P)

      : サイン付内部10進数。符号付きのパック形式の10進数データ形式。ただし、18桁までしか扱えません。

    double_byte_graphic_characters (N)

      : 2バイト表示文字。シフトコードがない2バイトコードのみの文字データ形式。EBCDICコードが含まれていてはいけません。偶数バイトしか扱えません。HULFT for MainframeまたはHULFT for IBMiの場合、シフトコードを含まない2バイトコードのときに使用します。

    variable_length_characters (M)

      : 可変長文字。EBCDICコードと2バイトコードが混在する文字データ形式。HULFT for MainframeまたはHULFT for IBMiの場合、2バイトコードはシフトコードで囲まれている必要があります。

    unsigned_external_decimal (9)

      : サイン無外部10進数。符号を持たないゾーン形式の10進数データ形式。

    floating_point (F)

      : 浮動小数点タイプ。符号付きの浮動小数点データ形式。MainframeはIBMフォーマット、その他の機種はIEEEフォーマットの浮動小数形式をサポートします。

    image (I)

      : イメージタイプ（無変換）。無変換を表すデータ形式。

    signed_external_decimal (S)

      : サイン付外部10進数。符号付きのゾーン形式の10進数データ形式。

  ]

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

    詳細エラー情報

  ]