Skip to content
Sub Account View

Corporate Action Sub Position View

Query the corporate-action sub-position view configuration.

Request parameters

  • This dataset exposes no business filter fields; pass an empty filters object. You can still use page, page_size, and orderBy to control pagination and sorting.

Business notes

Maintains the sub-position view configuration used in corporate-action processing, to group and present the relevant sub-positions by view.

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/corp_action_sub_position_views

Authorization

AuthorizationstringheaderRequired

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

Permission

corporate.sub_account_view_query

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.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Corporate Action Sub Position View 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

Returned value: Unique identifier of the current record.

view_namestring

Returned value: View Name.

usage_scenestring

Returned value: Usage Scenario.

usage_scene_valstring

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

statusstring

Returned value: Status.

status_valstring

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

remarkstring

Returned value: Remarks.

created_atstring

Returned value: Creation Time. The date or time format follows the value returned by the API.

created_bystring

Returned value: Created By.

created_by_valstring

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

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

Whale Docs