Skip to content
Longport Whale
Remarks template

Remarks template Export

Export the Remarks template list to a file. In sync mode (mode:0) the download URL is returned directly; in async mode (mode:1) a file_download_id is returned, to be polled via the shared GET/DELETE /v1/datasets/download/{id} endpoint for status and the final download URL.

POSThttps://b-api.longbridge.xyz/v1/datasets/atm_remark_templates/download

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters. Same fields as the filters of atm_remark_templates.yaml (the query capability).

Child attributes
filters.idstring

ID

filters.config_value_multi_langstring

Remarks

filters.updated_atobject

Updated At. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes
filters.updated_at.gtestring

Greater Than or Equal

filters.updated_at.ltestring

Less Than or Equal

filters.lookup_categorystring

Remarks User. Options: setting_remark_deposit = Deposit; setting_remark_withdrawal = Withdrawal; setting_remark_securitiesdeposit = Securities Deposit; setting_remark_securitieswithdrawal = Securities Withdrawal; setting_remark_accountadjustment = Account Adjustment; setting_remark_withdrawal_reject = Withdrawal rejection; setting_remark_deposit_reject = Deposit rejection; setting_remark_withdrawal_card_reject = Refuse Add Bank Card; setting_remark_fund = Fund; setting_remark_otc_derivatives = OTC Derivatives; setting_remark_deposit_matching = Deposit Matching

setting_remark_depositsetting_remark_withdrawalsetting_remark_securitiesdepositsetting_remark_securitieswithdrawalsetting_remark_accountadjustmentsetting_remark_withdrawal_rejectsetting_remark_deposit_rejectsetting_remark_withdrawal_card_rejectsetting_remark_fundsetting_remark_otc_derivativessetting_remark_deposit_matching

orderByarray<object>

Order By

modeinteger

Mode. Defaults to 0 (sync) when omitted.. Options: 0 = Sync; 1 = Async

01

extstring

Ext. Supports csv/xlsx; defaults to csv.

csvxlsx

file_namestring

File Name

remarkstring

Remark

down_fieldsarray<string>

Down Fields. When omitted, all fields are exported; allowed values are listed under items.enum (the same field list as the query endpoint's data.list.items).

ticket_contentstring

Ticket Content. Shown to the approver when the template has a download-approval ticket configured.

ticket_preview_urlstring

Ticket Preview URL

hideinteger

Hide. Options: 0 = Not Hidden; 1 = Hidden

01

Responses

HTTP 200Export result. In sync mode the download URL is returned directly; in async mode a file_download_id is returned for subsequent polling.
Standard response envelopecodemessagedata
dataobjectdata structure
urlstring

Download URL. Returned in sync mode (mode:0); empty in async mode.

file_download_idstring

File Download ID. Returned in async mode (mode:1); used to poll GET/DELETE /v1/datasets/download/{id}.

ticket_idstring

Ticket ID

Whale Docs