Skip to content
Longport Whale
Health Check Before Clearing

Upsert Clearing Ready Setting

Submitted by the "Add/Edit" form on the Health Check Before Clearing page. It changes the live configuration of pre-clearing check items.

POSThttps://b-api.longbridge.xyz/clearing/upsert_clearing_ready_setting

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

task_codestringrequired

Task Code. The corresponding input in the edit form is read-only (readOnly); the actual submitted value comes from the current row's task_code_val field rather than user input.

task_namestringrequired

Task Name. On submission, takes the task_code field value (display name) of the current row record, matching the content of the read-only form input.

process_modestring

Post-failure Processing Mode. Dropdown selection (form field process_mode). Options are fetched dynamically via GET /data_porter/refs?ref_ids=clear_ready_process_mode (Accept-Language: zh-CN / en); the example value "1" is taken from a real audit-log template payload.

is_enableboolean

Enable/Disable. A switch component; before submission it is converted to a boolean via values.is_enable === true || values.is_enable === 'true'.

audit_frontend_resourceobject

Audit Frontend Resource (auxiliary). A non-business field used only to display the before/after state in the audit log; the front end builds it as { ...currentItem, after_enable, before_enable }, containing the two booleans before_enable/after_enable for the enabled state before and after the change.

Responses

HTTP 200No confirmable field definitions are available for the response yet.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs