再集信要求

何らかの理由によりファイルを受信できなかった場合に、集信側ホストは再集信要求行い、配信側ホストに配信を要求します。
通常、再集信要求は受信できなかった位置(データ)から受信します(チェックポイント再集信)。

Examples

REQUEST EXAMPLE

サンプルは以下となります。

{
  "file_id": "LOOPBACK_ID",
  "host_id": "LOOPBACK-HOST",
  "checkpoint_rereceive": "enable"
}

Request Interface

https://ControlURL/api/v1/requests/rereceivings

REQUEST BODY SCHEMA : application/json

file_id : string

ファイルID(必須)

50バイト以内の英大文字数字、および”_”で指定します。

host_id : string

ホストID

255バイト以内の英数字、”_”、および”.”で指定します。

checkpoint_rereceive : string

チェックポイント再集信

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

enable

: チェックポイントから再集信

disable

: 先頭から再集信

値を指定しなかった場合は、初期値の「enable」が設定されます。

Response Interface

202 Accepted

RESPONSE HEADERS

X-Request-ID : string

WebAPI履歴のレコードID

RESPONSE SCHEMA : application/json

process_id : string

処理識別子

meta : object

メタ情報

request_user : object

ロール情報

systems_role : string

リクエストユーザーのシステム権限ロール

managements_id_role : string

リクエストユーザーの管理情報権限ロール

hulft_id : string

HULFT ID

file_id : string

ファイルID

display_name : string

ファイルID表示名

accept_datetime : string <date-time>

受付日時

connection_ids : Array of strings

要求により実行された転送ごとの接続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)) 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

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

詳細エラー情報

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

クエリ情報

]

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

詳細エラー情報

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

クエリ情報

]