# ジョブ履歴の一覧取得

ジョブ履歴の一覧を取得します。

## Request Interface

    http://ControlURL/api/v1/hulft/{hulft-host-id}/logs/jobs/list

= 備考 =

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

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

QUERY PARAMETERS

job-search-mode : string

  集配区分 （必須）

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

  send

    : 配信履歴のジョブ履歴が対象となります。

  receive

    : 集信履歴のジョブ履歴が対象となります。

file-id : string

  検索したいファイルIDを指定

  50バイト以内の文字列で指定します。

  転送IDを指定しない場合は、必須指定です。

hostname : string

  検索したいホスト名を指定

  68バイト以内の文字列で指定します。

  転送IDを指定しない場合は、必須指定です。

transfer-start-date : string

  配信開始日付/集信開始日付を指定

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

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

  転送IDを指定しない場合は、必須指定です。

transfer-start-time : string

  配信開始時刻/集信開始時刻を指定

  形式はHHMMSSです。

  転送IDを指定しない場合は、必須指定です。

transfer-end-time : string

  配信完了時刻/集信完了時刻を指定

  形式はHHMMSSです。

  転送IDを指定しない場合は、必須指定です。

transfer-id : string

  検索したい最新転送IDを指定

  64バイトの文字列で指定します。

  16進数(0-9,a-f)文字で指定します。

  配信開始日付/集信開始日付を指定しない場合は、必須指定です。

  最新転送IDが配信履歴/集信履歴に含まれる場合、最新転送ID省略すると、正しくジョブ履歴を取得できない場合があります。

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

  job_name : string

    ジョブ名

  executed_date : string

    ジョブ実行日

  started_time : string

    開始時刻

  ended_time : string

    終了時刻

  status_code : integer

    ステータス

  ibmi : object

    IBM i（AS/400）環境管理情報

    message_id : string

      メッセージID

    severity : string

      重大度

  ]

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

    詳細エラー情報

  ]