# マルチフォーマット情報の登録

マルチフォーマット情報を登録します。

## Examples

REQUEST EXAMPLE

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

    {
      "id": "MFORMATID",
      "comment": "人事情報ファイルマルチフォーマット",
      "default_format_id": "DEFAILTFORMATID",
      "key_start_position": 1,
      "key_length": 4,
      "mformats": [
          {
            "key_value": "key1",
            "format_id": "FORMATID1"
          },
          {
            "key_value": "key2",
            "format_id": "FORMATID2"
          }
      ]
    }

## Request Interface

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

= 備考 =

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

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

REQUEST BODY SCHEMA : application/json

id : string

  マルチフォーマットID （必須）

  登録したマルチフォーマットを認識するためのID

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

  このマルチフォーマットIDと配信管理情報のマルチフォーマットIDが関連づけされます。

comment : string

  コメント

  マルチフォーマットに対するコメント

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

default_format_id : string

  デフォルトフォーマットID

  データ内のキーと一致しなかった場合の初期値のフォーマットID

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

  「デフォルトフォーマットID」を指定しておくと、データ内のキーがマルチフォーマットの登録されたキーと一致しないとき、「デフォルトフォーマットID」のフォーマットが使用されます。

  「デフォルトフォーマットID」を指定しないと、キーと一致しなかった場合、変換エラーとなります。

key_start_position : integer

  キー開始位置 （必須）

  レコード単位に設定するキーの開始位置

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

  キー開始位置とキー長を足した値が「19998」を超える値は設定できません。

  キー開始位置をフォーマット情報の長さよりも大きくすると、キー値が正しく適用されません。

key_length : integer

  キー長 （必須）

  レコード単位に設定するキーの長さ

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

mformats : Array of objects

  フォーマット情報 （必須）

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

  Array[

  key_value : string

    キー値 （必須）

    レコード単位に設定するキー

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

    キーはキー長と同じ長さの英数字で指定します。

    キー値を設定する領域の「項目タイプ」は、以下のいずれかを指定してください。

    - character (X): キャラクタ

    - variable_length_characters (M): 可変長文字

  format_id : string

    フォーマットID （必須）

    キーが一致した場合に使用するフォーマットID

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

    フォーマット情報に登録されているフォーマットIDを指定します。

    キー値と同じ個数の登録が必要です。

    キー値からフォーマットIDを識別し、データに適用します。

  ]

## Response Interface

### 201 Created 情報登録

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

  コメント

default_format_id : string

  デフォルトフォーマットID

key_start_position : integer

  キー開始位置

key_length : integer

  キー長

mformats : Array of objects

  フォーマット情報

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

  Array[

  key_value : string

    キー値

  format_id : 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))

    "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

    詳細エラー情報

  ]

### 409 登録済みの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

    詳細エラー情報

  ]