Skip to content
Longport WhaleLongport Whale
Batch Printing

Create Batch Export Task

Create a new batch export task for a given batch.

Request parameters

  • Required: batch_id (batch ID), operator (identifier of the operator initiating this action, for audit tracing)
  • Optional: bind_id (binding ID), sync_sftp (whether to sync to SFTP)
  • See each field's documentation for format, value ranges, and business meaning.

Business notes

Generates export files in bulk for the reports configured in the batch. The task runs asynchronously; progress and results can be queried through the export task list.

Result

On success, the batch export task is created; refer to the 200 response definition for the resulting state and returned data.

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

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 above, 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