Batch Print List · Whale Docs

POSThttps://b-api.longbridge.xyz/v1/datasets/report_export_batches

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

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

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

namestring

Filters results by Batch Name.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Batch Print List records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

idstring

Returned value: Unique identifier of the current record.

namestring

Returned value: Batch Name.

sync_sftpstring

Returned value: Synchronized SFTP.

sync_sftp_valstring

Raw value of sync_sftp. The sync_sftp field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

auto_export_timingstring

Returned value: Printing Type.

auto_export_timing_valstring

Raw value of auto_export_timing. The auto_export_timing field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

report_numstring

Returned value: Report Number.

latest_export_userstring

Returned value: Recent Exporter.

latest_export_user_valstring

Raw value of latest_export_user. The latest_export_user field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

latest_exported_atstring

Returned value: Recent Export Time. The date or time format follows the value returned by the API.

creatorstring

Returned value: Creator.

creator_valstring

Raw value of creator. The creator field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_datestring

Returned value: Created Date. The date or time format follows the value returned by the API.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/report_export_batches' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "17907",
        "name": "qqqqq",
        "sync_sftp": "No",
        "sync_sftp_val": "0",
        "auto_export_timing": "Manual Export",
        "auto_export_timing_val": "Manual",
        "report_num": "1",
        "latest_export_user": "",
        "latest_export_user_val": "",
        "latest_exported_at": "--",
        "creator": "示例用户",
        "creator_val": "user@example.com",
        "created_date": "1781616226"
      }
    ],
    "total": 591
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.longbridge.xyz/v1/datasets/report_export_batches/download

report.export_batches_query

Export options Export records Download result