Skip to content
Longport WhaleLongport Whale
File import

Create OB File Import

Submit after a successful file upload to create an upstream source-file import task.

Request parameters

  • Required: file_name (file name), file_type (file type), key (object-storage key), market (market), strategy (parse strategy), biz_date (business date)
  • Optional: is_reconciliation (whether reconciliation is needed), audit_frontend_resource (audit context)
  • See each field's description for format, value range, and business meaning.

Business notes

key is the object-storage identifier returned by the upload and locates the uploaded file. Once created, the task imports and persists the file per the chosen parse strategy.

Risk warning

This operation may change real funds, positions, or trade status. Confirm the target record and parameters before calling.

Result

On success, the operation completes; the resulting state and returned data follow the 200 response definition.

PUThttps://b-api.lbkrs.com/corporate_action/upload_source_file

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

lb_hk_corporate.corporate_query

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

file_namestringrequired

Name of the file to process, including its file extension. This field is required.

file_typenumberrequired

This field is required. Values come from a backend data dictionary (maintained dynamically), not a fixed enum; use the options the service actually returns.

keystringrequired

Object-storage key returned after the file is uploaded; identifies the file to process. This field is required.

marketstringrequired

This field is required.

strategystringrequired

This field is required.

biz_datestringrequired

Biz Date associated with this request. Use the date format defined by the API. This field is required.

is_reconciliationboolean

Boolean flag for is reconciliation.

Boolean values:

  • true - The condition applies
  • false - The condition does not apply
audit_frontend_resourceobject

Provides audit context for this operation.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

On success data is an empty object.

No nested fields

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs