Clearing - Pre-Clearing Preparation Task

Queries Clearing - Pre-Clearing Preparation Task data. Combine business filters in filters, and use page and page_size to control pagination.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

GEThttps://b-api.longbridge.xyz/v1/datasets/clearing_ready_tasks

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

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

Query parameters

filtersobject

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

Child attributes

task_codestring

Filters results by Check Items.

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

flowstring

Filters results by Check Phase.

Allowed values:

1 - Trade Clearing
2 - Day End

1 · Trade Clearing2 · Day End

process_modestring

Filters results by Post-Failure Treatment.

Allowed values:

0 - Tip Only
1 - Ticket Process
2 - Forced Calibration

0 · Tip Only1 · Ticket Process2 · Forced Calibration

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Clearing - Pre-Clearing Preparation Task 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

task_codestring

Returned value: Check Items.

task_code_valstring

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

flowstring

Returned value: Check Phase.

flow_valstring

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

process_modestring

Returned value: Post-Failure Treatment.

process_mode_valstring

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

is_enablestring

Returned value: Indicates whether enable/disable.

operatorstring

Returned value: Operator.

operator_valstring

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

updated_atstring

Returned value: Updated At. 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 --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/clearing_ready_tasks' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={"task_code":"ready_transaction_file_import","flow":"1","process_mode":"2"}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "task_code": "string",
        "task_code_val": "string",
        "flow": "string",
        "flow_val": "string",
        "process_mode": "string",
        "process_mode_val": "string",
        "is_enable": "string",
        "operator": "string",
        "operator_val": "string",
        "updated_at": "string"
      }
    ],
    "total": 1
  }
}

Export

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

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

Export options Export records Download result