再配信要求
配信処理中に何らかの問題が発生し、配信が中断すると異常終了したファイルの情報が再配信待ちファイルに書き込まれます。
再配信要求はこの再配信待ちファイルに書き込まれたファイルに対して要求します。
通常、再配信は異常が発生した位置（データ）からの配信になります（チェックポイント再配信）。
Examples
REQUEST EXAMPLE
サンプルは以下となります。
{
"file_id": "LOOPBACK_ID",
"file_name": "/tmp/snd_doc",
"host_id": "LOOPBACK-HOST",
"checkpoint_resend": "enable"
}
Request Interface
https://ControlURL/api/v1/requests/resendings
WebAPIのControlURLで指定するパスはHULFTの管理画面にアクセスするためのURLと同じURLです。
詳細は以下を参照してください。
REQUEST BODY SCHEMA : application/json
- file_id : string
-
ファイルID
50バイト以内で指定します。
英大文字数字、および“_”で指定します。
- file_name : string
-
配信ファイル名
4085バイト以内で指定します。
- host_id : string
-
ホストID
255バイト以内で指定します。
英数字、“-”、および“.”で指定します。
- checkpoint_resend : string
-
チェックポイント再配信
以下のいずれかを指定します。
- enable
-
: チェックポイントから再配信
- disable
-
: 先頭から再配信
省略すると、“enable”が設定されます。
Response Interface
202 Accepted
RESPONSE HEADERS
- X-Request-ID : string
-
WebAPI履歴のリクエストID
RESPONSE SCHEMA : application/json
- meta : object
-
メタ情報
- total : integer
-
検索条件に一致するレコードの総数
- request_user : object
-
ロール情報
- systems_role : string
-
APIを実行したユーザーの「ユーザーの権限」
- records : Array of objects
-
条件に合致した再配信対象
以下の構造の情報（Array[]）が複数取得されます。
Array[
- connection_id : string
-
接続ID
- hulft_id : string
-
HULFT ID
- file_id : string
-
ファイルID
- display_name : string
-
配信管理情報の表示名
- accept_datetime : string <date-time>
-
受付日時
]
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
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
-
クエリ情報
]