Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Layouts/ Querying the Layout Page
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Layout Page

Function

This API is used to query the layout page.

Calling Method

For details, see Calling APIs.

URI

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

wizard_id

Yes

String

Layout page 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

Response Parameters

Status code: 200

Table 3 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.
Table 4 Response body parameters

Parameter

Type

Description

code

String

Error code.

message

String

Error message

data

WizardDetailInfo object

Information of layout wizard detail
Table 5 WizardDetailInfo

Parameter

Type

Description

create_time

String

Create time

creator_id

String

Creator id value

description

String

The description, display only

en_description

String

english description of layout wizard

id

String

Id value

wizard_json

String

Layout page information.

name

String

The name, display only

en_name

String

english name of layout module

update_time

String

Update time

project_id

String

Project id value

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.
Table 6 binding_button

Parameter

Type

Description

button_id

String

Button ID.

button_name

String

Button name.

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

None

Example Responses

None

Status Codes

Status Code

Description

200

Layout page details.

400

Error response

Error Codes

See Error Codes.

Parent topic: Layouts