Skip to content
Task List

CRS Log Query

Queries the task logs for generating and submitting CRS reporting files, used to track task progress and trace operation history.

Request parameters

  • Combine business filters through filters (available fields are described under the filters section below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

The data is CRS task execution records, organized by return year, AEOI ID, company name, batch, and task type.

Each record carries the task type, execution status, start and end times (creation / update time), operator, generated file name and file serial number, and remarks.

It is typically used to track the progress of CRS file generation and submission, investigate failed tasks, and trace operation history.

Returns

On success, returns the matching record list together with pagination information. See the response definition for the meaning of each returned column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

report.crs_tasks

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

Request body application/json

filtersobject

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

Child attributes
company_namestring

Filters results by Company Name.

Values are dynamic. Call GET /v1/datasets/refs/crs_company_name to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

aeoi_idstring

Filters results by Aeoi Id.

Values are dynamic. Call GET /v1/datasets/refs/crs_aeoi_id to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

return_yearstring

Filters results by Return Year.

Values are dynamic. Call GET /v1/datasets/refs/crs_return_year to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

batchstring

Filters results by Batch.

Values are dynamic. Call GET /v1/datasets/refs/crs_batch to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

task_typestring

Filters results by Task Type.

Allowed values: 1 Data Task, 2 Test File Task, 3 File Task, 4 Import History Data Task

Values
1
Data Task
2
Test File Task
3
File Task
4
Import History Data Task
pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated CRS Log Query 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.

return_yearstring

Returned value: Return Year.

aeoi_idstring

Returned value: Aeoi Id.

company_namestring

Returned value: Company Name.

batchstring

Returned value: Batch.

task_typestring

Returned value: Task Type.

task_type_valstring

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

statusstring

Returned value: Status.

status_valstring

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

start_datetimestring

Returned value: Start Datetime. The date or time format follows the value returned by the API.

end_datetimestring

Returned value: End Datetime. The date or time format follows the value returned by the API.

operatorstring

Returned value: Operator.

file_serial_numstring

Returned value: File Serial Number.

remarkstring

Returned value: Remark.

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

Whale Docs