Skip to content
Longport WhaleLongport Whale
File import

Create OB File Import

Upload the import file first, then submit the request to create an upstream-file import task.

Request parameters

  • Required: file_name (File Name), file_type (File Type), key (S3 Object Key), market (Market), strategy (Strategy), biz_date (Biz Date)
  • Optional: is_reconciliation (Is Reconciliation), audit_frontend_resource (Audit Context)
  • See each field for its format, allowed values, default behavior, and business meaning.

Result

On success, the endpoint completes the described business operation. See the 200 response schema for returned data.

PUThttps://b-api.longbridge.xyz/corporate_action/upload_source_file

Authorization

Authorizationstringheaderlb_hk_corporate.corporate_queryRequired

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

Request body application/json

file_namestringrequired

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

file_typenumberrequired

Specifies File Type. This field is required.

keystringrequired

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

marketstringrequired

Specifies Market. This field is required.

strategystringrequired

Specifies Strategy. 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