Skip to content
Longport WhaleLongport Whale
Print Report

Set Report Disabled Columns

Sets the columns that should be hidden (disabled) for a report.

Request parameters

  • Required: report_id (report ID), keys (list of columns to disable).
  • See the field descriptions for each parameter's format, allowed values, and business meaning.

Business notes

Each element of keys is the field key of a column to hide. This setting controls which columns are omitted when the report is displayed and exported, and it replaces the report's existing disabled-column configuration.

Result

On success, the report's disabled-column configuration is updated. Subsequent state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/report/set_disable_col

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_report.report_printing

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

Request body application/json

report_idstringrequired

The report_id of the current report page.

keysarray<string>required

Elements are the field identifiers (column names) of the hidden columns.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

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