Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Layouts/ Batch Updating Layout Pages

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

CLI Examples

View PDF

Batch Updating Layout Pages

This API is used to update a layout.

For details, see Calling APIs.

PUT /v1/{project_id}/workspaces/{workspace_id}/soc/layouts/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

**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
layout_wizard_update_pojo_list	No	Array of WizardUpdateRequestPojo objects	Request body list for updating a layout.

**Table 4** WizardUpdateRequestPojo
Parameter	Mandatory	Type	Description
create_time	No	String	Creation time.
creator_id	No	String	Creator ID.
description	No	String	Description.
id	No	String	Layout ID.
wizard_json	No	String	Layout page information.
name	No	String	Layout name.
update_time	No	String	Update time.
layout_id	No	String	Layout ID.
project_id	No	String	Tenant ID.
workspace_id	No	String	Workspace ID.
is_binding	No	Boolean	Whether the button has been associated.
binding_button	No	Array of binding_button objects	Associated button.
boa_version	No	String	BOA base version.

**Table 5** binding_button
Parameter	Mandatory	Type	Description
button_id	Yes	String	Button ID.
button_name	No	String	Button name.

Status code: 200

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

**Table 7** Response body parameters
Parameter	Type	Description
code	String	Error code.
data	Array of WizardDetailInfo objects	Data list.

**Table 8** 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.