Skip to content
Longport WhaleLongport Whale
File Rules

File Receiving Rules

Query the list of file receiving rules.

GEThttps://b-api.longbridge.xyz/v1/datasets/ipo_ob_file_upstream_configs

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.ob_file_receive_rules

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

Query parameters

filtersobject
pageinteger
page_sizeinteger

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required
Child attributes
idstring
marketstring
market_valstring

Raw value of market. The market field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

file_codestring
file_code_valstring

Raw value behind field file_code: file_code returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

custodian_codestring
custodian_code_valstring

Raw value behind field custodian_code: custodian_code returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

settlement_channel_codestring
settlement_channel_code_valstring

Raw value of settlement_channel_code. The settlement_channel_code field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

parent_account_channelstring
parent_account_channel_valstring

Raw value behind field parent_account_channel: parent_account_channel returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

totalintegerrequired
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