Skip to content
Print Report

Create Report Export Task

Creates a report export task. View the result under Download Report > Export Log.

Request parameters

  • Required: report_id (Report ID), file_type (File Type), operator (Operator), columns (Export Columns), porter_params (Porter Params)
  • Optional: paper (Paper Size)
  • 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.

POSThttps://b-api.lbkrs.com/report/export_task/new

Production: https://b-api.lbkrs.com · Test: https://b-api.longbridge.xyz

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_report.report_printing

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

Request body application/json

report_idstringrequired

The current report page's route parameter report_id.

file_typestringrequired

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

pdf · PDFcsv · CSVexcel · Excel

operatorstringrequired

Identifier of the operator initiating this request, used for audit tracing. This field is required.

columnsarray<string>required

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

porter_paramsobjectrequired

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

paperstring

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

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure
task_idstring
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