Skip to content
Longport Whale
Print Report

Create Report Export Task

Submitted by the "Export" dialog on the Print Report page, creating a report-export task; the result can be viewed in Download Report / Export Log.

POSThttps://b-api.longbridge.xyz/report/export_task/new

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

report_idstringrequired

Report ID. The current report page's route parameter report_id.

file_typestringrequired

File Type. Enum: pdf/csv/excel, single-select; only the types included in the export_supported_types returned by the report/condition endpoint are selectable.

operatorstringrequired

Operator. The current logged-in user's name.

columnsarray<string>required

Export Columns. The list of dataporter_index values for the report's currently sorted/displayed columns.

porter_paramsobjectrequired

Porter Params. The query conditions of the current report list (with the pagination fields page/page_size removed); the field structure varies by report template.

paperstring

Paper Size. Attached for some reports; values come from the supported_paper_size list returned by the report/condition endpoint.

Responses

HTTP 200No confirmable field definitions are available for the response yet.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs