Upsert Clearing Ready Setting

Cross-check the request against the actual payload example in the audit template. This operation changes live pre-clearing checklist configuration.

Request parameters

Required: task_code (Task Code), task_name (Task Name)
Optional: process_mode (Post-failure Processing Mode), is_enable (Enable/Disable), audit_frontend_resource (Audit Frontend Resource (auxiliary))
See each field for its format, allowed values, default behavior, and business meaning.

Result

On success, the endpoint completes the described business operation. See the 200 response schema for returned data.

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

The corresponding field is read-only on the edit form. Its submitted value comes from task_code_val on the selected record, not from user input.

task_namestringrequired

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

Processing mode to apply when a pre-clearing check fails.

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

Allowed values:

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

0 · Tip Only1 · Ticket Process2 · Forced Calibration

is_enableboolean

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

audit_frontend_resourceobject

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 200The request was processed successfully. The response data does not contain additional business fields.