Skip to content
Longport WhaleLongport Whale
Batch Printing

Create Export Batch

Create a batch-print / export batch.

Request parameters

  • Required: name (batch name), sync_sftp (whether to sync to SFTP), email_notify (whether to notify by email)
  • Optional: auto_export_timing (scheduled auto-export timing; no auto-export when omitted), visible_emails (list of user emails granted visibility)
  • See each field's documentation for format, value ranges, and business meaning.

Business notes

A batch is a container for bulk report export. After creation you can add report configurations to it and trigger batch export tasks.

Result

On success, the export batch is created and the business result is carried in data; interpret it together with the business code.

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

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

namestringrequired

Batch name.

sync_sftpbooleanrequired

Whether to sync to SFTP.

email_notifybooleanrequired

Whether to send an email notification.

auto_export_timingstring

Auto-export timing; not auto-exported when omitted.

visible_emailsarray<string>

Emails allowed to see the batch. No restriction when omitted.

Responses

HTTP 200The request was processed successfully. The business result is in data.
Standard response envelopecodemessagedata
dataobjectdata structure
batch_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