Bookmark Directory List

Returns all report bookmark directories used to organize and group bookmarked reports.

Request parameters

This endpoint takes no required parameters.

Returns

On success, data.list contains all report bookmark directories. Each item includes the directory ID dir_id and directory name name. See the response definition below for field details.

GEThttps://b-api.lbkrs.com/report/bookmark/dir_list

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.

Responses

HTTP 200The request was processed successfully. The business result is in data.list.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>

Report bookmark directory list.

Child attributes

dir_idstring

Bookmark directory ID.

namestring

Bookmark directory name.

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 GET \
  --url 'https://b-api.lbkrs.com/report/bookmark/dir_list' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "dir_id": "D-0001",
        "name": "Default Folder"
      }
    ]
  }
}