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

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

CLI Examples

View PDF

Querying the Layout Page List

This API is used to query all layouts.

For details, see Calling APIs.

GET /v1/{project_id}/workspaces/{workspace_id}/soc/layouts/{layout_id}/wizards

**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
layout_id	Yes	String	Layout ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Pagination.
limit	No	Integer	Definition Data volume. Constraints N/A Range N/A Default Value N/A
sort_key	No	String	Definition Sorting field. create_time: creation time update_time: update time. Constraints N/A Range create_time update_time Default Value create_time
sort_dir	No	String	Definition Sorting order. ASC: ascending order DESC: descending order Constraints N/A Range ASC: ascending order DESC: descending order Default Value DESC

**Table 3** 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

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 WizardDetailInfo 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** WizardDetailInfo
Parameter	Type	Description
create_time	String	Creation time.
creator_id	String	Creator ID.
description	String	Description.
en_description	String	English description.
id	String	Layout ID.
wizard_json	String	Layout page information.
name	String	Layout name.
en_name	String	Name in English.
update_time	String	Update time.
project_id	String	Tenant ID.
workspace_id	String	Workspace ID.
is_binding	Boolean	Whether the button has been associated.
binding_button	Array of binding_button objects	Associated button.
is_built_in	Boolean	Whether the page is a system page.
boa_version	String	BOA base version.
version	String	SecMaster edition.