Modifying a Layout

Function

This API is used to modify a layout.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/workspaces/{workspace_id}/soc/layouts/{layout_id}

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

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.
description	No	String	The description, display only
cloud_pack_id	No	String	Subscription ID.
cloud_pack_name	No	String	Subscription package name.
cloud_pack_version	No	String	Subscription package version.
is_built_in	No	Boolean	Built-in or not. true: Built-in; false: Custom.
is_template	No	Boolean	Layout template.
layout_json	No	Object	Layout information.
fields_sum	No	Integer	Total number of fields. This parameter is not returned when used_by is SECURITY_REPORT or DASHBOARD.
wizards_sum	No	Integer	Total number of pages. This parameter is not returned when used_by is SECURITY_REPORT or DASHBOARD.
sections_sum	No	Integer	Total number of system indicators.
tabs_sum	No	Integer	Total number of custom indicators.
boa_version	No	String	BOA base version.

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.
message	String	Error message.
request_id	String	Request id
success	Boolean	Request result.
data	LayoutDetailInfo object	Information of layout detail

**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	Create time
creator_id	String	Creator id value
creator_name	String	Creator name value
description	String	The description, display only
en_description	String	english description of layout
id	String	Subscription ID.
name	String	The name, display only
en_name	String	english name of layout
layout_json	String	Wizard ID list in the layout.
project_id	String	Project id value
update_time	String	Update time
workspace_id	String	workspace id
region_id	String	region id
domain_id	String	domain 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 indicators.
tabs_sum	Integer	Total number of custom indicators.
version	String	SecMaster edition.
boa_version	String	BOA base version.