List reports under a batch

Query the list of reports configured under a specific print batch, used to review which reports are included in the batch and their print settings.

Request parameters

Combine business filters through filters (see the filter field notes below), and use page, page_size, and orderBy to control pagination and sorting. Specify the owning batch to scope the query.

Business notes

The data lists the reports added to a batch print batch; each record corresponds to one report in the batch.
A record carries the report name, file type, remark, and print conditions, where the print conditions record the parameter configuration used when exporting that report.
Typically used to maintain batch members and verify each report's export format and filter conditions before running a batch export.

Returns

On success, returns the matching record list with pagination info. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/report_batch_export_reports

Authorization

AuthorizationstringheaderRequired

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

Permission

report.batch_export_reports_query

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

Request body application/json

filtersobject

Child attributes

titlestring

Filters results by Report name.

pageinteger

page_sizeinteger

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Child attributes

idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

titlestring

Report name. Returned value: Report name.

file_typestring

File type. Returned value: Export file type of the report, e.g. pdf.

remarkstring

Remark. Returned value: Remark; may be an empty string.

export_paramsstring

Print conditions. Returned value: Parameters used when exporting the report (JSON string).

totalintegerrequired

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.lbkrs.com/v1/datasets/report_batch_export_reports' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "123",
        "title": "张三",
        "file_type": "1",
        "remark": "审核通过",
        "export_params": "string"
      }
    ],
    "total": 1
  }
}

Export

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

POSThttps://b-api.lbkrs.com/v1/datasets/report_batch_export_reports/download

report.batch_export_reports_query

Export options Export records Download result