Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Layouts/ Querying the Layout List

Updated on 2025-12-18 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying the Layout List

Function

This API is used to query the layout list.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/layouts/search

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A
workspace_id	Yes	String	Definition Workspace ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A
content-type	Yes	String	Definition Content type. application/json;charset=UTF-8: common API request type Constraints N/A Range application/json;charset=UTF-8 Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	No	String	Layout name.
used_by	No	String	Layout type.
binding_code	No	String	business_code of the data class selected for creating a layout.
is_built_in	No	Boolean	Whether to search for built-in layouts.
is_template	No	Boolean	Whether to search for layout templates.
is_default	No	Boolean	Whether to search for default layouts.
layout_type	No	String	Layout page type.
offset	No	Integer	Pagination.
limit	No	Integer	Number of records on each page.
sort_key	No	String	Sorting field.
sort_dir	No	String	Sorting in ascending or descending order.
search_txt	No	String	Keyword.
from_date	No	String	Start time.
to_date	No	String	End time.

Response Parameters

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID. Format: request_uuid-timestamp-hostname.

**Table 5** Response body parameters
Parameter	Type	Description
code	String	Error code.
data	Array of LayoutDetailInfo objects	Data list.
message	String	Response information.
offset	Integer	Pagination.
request_id	String	Request ID.
limit	Integer	Number of records on each page.
success	Boolean	Whether the response is successful.
total	Integer	Total number.

**Table 6** LayoutDetailInfo
Parameter	Type	Description
cloud_pack_id	String	Subscription ID.
cloud_pack_name	String	Subscription package name.
cloud_pack_version	String	Subscription package version.
is_built_in	Boolean	Built-in or not. true: Built-in; false: Custom.
is_template	Boolean	Layout template.
create_time	String	Creation time.
creator_id	String	Creator ID.
parent_id	String	Parent layout ID.
creator_name	String	Creator name.
description	String	Description.
en_description	String	Description.
id	String	Subscription ID.
name	String	Name.
en_name	String	Name in English.
layout_json	String	Wizard ID list in the layout.
project_id	String	Tenant ID.
update_time	String	Update time.
workspace_id	String	Workspace ID.
region_id	String	Region ID.
domain_id	String	User ID.
thumbnail	String	Template thumbnail. This parameter cannot be empty when the layout is a template.
used_by	String	Services that use the template (DATACLASS, AOP_WORKFLOW, SECURITY_REPORT, DASHBOARD) and the corresponding fields.
layout_cfg	String	The parameter specifies which icon is used.
layout_type	String	Layout type. This parameter is not returned when used_by is SECURITY_REPORT or DASHBOARD.
binding_id	String	Data class ID or workflow ID. This parameter is not returned when used_by is SECURITY_REPORT or DASHBOARD.
binding_name	String	Data class name or workflow name. This parameter is not returned when used_by is SECURITY_REPORT or DASHBOARD.
binding_code	String	Data class name or workflow name. This parameter is not returned when used_by is SECURITY_REPORT or DASHBOARD.
fields_sum	Integer	Total number of fields. This parameter is not returned when used_by is SECURITY_REPORT or DASHBOARD.
wizards_sum	Integer	Total number of pages. This parameter is not returned when used_by is SECURITY_REPORT or DASHBOARD.
sections_sum	Integer	Total number of system modules.
modules_sum	Integer	Total number of system modules.
tabs_sum	Integer	Total number of custom indicators.
version	String	SecMaster edition.
boa_version	String	BOA base version.

Status code: 400

**Table 7** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID. Format: request_uuid-timestamp-hostname.

**Table 8** Response body parameters
Parameter	Type	Description
code	String	Definition Error code. Range N/A
message	String	Definition Error description. Range N/A

Example Requests

Query the layout list. Offset: 10. Quantity: 3.

{
  "limit" : 3,
  "offset" : 10
}

Example Responses

Status code: 200

Queried layout list.

{
  "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "message" : "Error message",
  "total" : 41,
  "limit" : 2,
  "offset" : 1,
  "success" : true,
  "data" : [ {
    "binding_code" : "Indicator",
    "binding_id" : "8e6e880c-caba-3511-88f6-545cc9f2a5bd",
    "binding_name" : "Indicator",
    "boa_version" : "v3",
    "create_time" : "2025-06-30T20:01:25Z+0800",
    "creator_id" : "system",
    "creator_name" : "system",
    "description" : "Description.",
    "en_description" : "Built-in layout, indicator management - Domain",
    "en_name" : "Domain",
    "fields_sum" : 17,
    "id" : "fc574642-7a4d-32bb-bb6f-ddcfb74624d9",
    "is_built_in" : true,
    "is_template" : false,
    "layout_cfg" : "indicator",
    "layout_json" : [ "28f87ba3-1146-4179-9799-5b5dbeee37ef" ],
    "layout_type" : "Detail",
    "modules_sum" : 0,
    "name" : "domain",
    "parent_id" : "144d0a96-db2c-3140-8a2f-ec30d8cee6c9",
    "project_id" : "15645222e8744afa985c93dab6341da6",
    "sections_sum" : 0,
    "tabs_sum" : 0,
    "update_time" : "2025-06-30T20:01:25Z+0800",
    "used_by" : "DATACLASS",
    "wizards_sum" : 1,
    "workspace_id" : "7e0f8248-5799-465e-9d94-9ff07f4b800d"
  } ]
}