Skip to content
Longport WhaleLongport Whale
Batch Printing

Create Batch Export Task

Create Batch Export Task.

Request parameters

  • Required: batch_id (Batch ID), operator (Operator)
  • Optional: bind_id (Bind ID), sync_sftp (Sync SFTP)
  • See each field for its format, allowed values, and business meaning.

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

POSThttps://b-api.lbkrs.com/report/export/new_batch_export_task

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

Authorization

AuthorizationstringheaderRequired

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

Permission

report.export_batches_query

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

Request body application/json

batch_idstringrequired

Batch ID associated with this request.

operatorstringrequired

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

bind_idstring

Bind ID associated with this request.

sync_sftpboolean

Boolean flag for sync sftp.

Boolean values:

  • true - The condition applies
  • false - The condition does not apply

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

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