# 転送状況の一覧取得

転送状況の一覧を取得します。

## Request Interface

    http://ControlURL/api/v1/hulft/{hulft-host-id}/statuses/transferrings/list

= 備考 =

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

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

QUERY PARAMETERS

limit : integer

  検索件数の上限

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

search-date : string

  検索日付を指定

  指定した日付以降の配信受付日時を持った転送のみ取得します。

  「YYYYMMDD」の形式で指定します。

  接続先ホストのタイムゾーンで指定します。

  省略した場合は、すべての転送状況を取得する。

search-time : string

  検索時刻を指定

  形式はHHMMSSです。

  検索日付を省略した場合、指定できません。

## Response Interface

### 200 OK

RESPONSE HEADERS

X-Request-ID : string

  WebAPIのリクエストID

RESPONSE SCHEMA : application/json

meta : object

  メタ情報

  total : integer

    取得したレコードの総数

  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

    製品バージョン

records : Array of objects

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

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

  Array[

  type : string

    種別

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

    send

      : 配信中の転送状況

    receive

      : 集信中の転送状況

  file_id : string

    ファイルID

  latest_transfer_id : string

    転送ID

  hostname : string

    ホスト名

  file : object

    ファイル

    name : string

      ファイル名

    transferred : object

      転送済みファイル情報

      rows : integer

        転送済みレコード件数

  datetime : object

    日時情報

    accept : string <date-time>

      依頼を受け付けた日時が表示されます。

  status : string

    ステータス

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

    transferring

      : 転送中

    connecting

      : 接続中

    send_queue

      : 配信待ち

    standby

      : 待機中

    auto_resend_queue

      : 自動再配信待

    executing_job

      : ジョブ実行中

    outputting_csv

      : CSV出力中

    canceling

      : 取消中

  connect_count : integer

    接続回数

  zos : object

    z/OS（汎用機）環境管理情報

    sequence_no : integer

      処理番号

    connection_type : string

      接続形態

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

      lan

        : LAN接続

      other

        : LAN接続以外の接続形式。SAN接続など

  ]

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

    詳細エラー情報

  ]

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

    詳細エラー情報

  ]