Clearing - System Configuration

Query the clearing system's system-level configuration items.

Request parameters

Combine business filter conditions through filters (see the filter-field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Each record is one clearing-system config item, with the config name, enabled status, type, extra parameters, updater and update time; used to centrally manage the clearing system's runtime parameters.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_busin_step_edit

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

remarkstring

Filters results by Configuration Items.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Clearing - System Configuration 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

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

config_codestring

Returned value: Configuration Items.

config_code_valstring

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

enablestring

Returned value: Indicates whether enable/disable.

config_typestring

Returned value: Type.

config_type_valstring

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

valstring

Returned value: Other parameters.

makerstring

Returned value: Operator.

maker_valstring

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

created_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 --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/clearing_system_configs' \
  --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",
        "config_code": "Deposit interest switch",
        "config_code_val": "1001",
        "enable": "0",
        "config_type": "Switch",
        "config_type_val": "0",
        "val": "",
        "maker": "木木",
        "maker_val": "21206",
        "created_at": "1775631987"
      }
    ],
    "total": 23
  }
}

Export

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

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

lb_hk_clearing.clearing_busin_step_edit

Export options Export records Download result