Querying the Layout Page List
Function
List all wizards.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/layouts/{layout_id}/wizards
|
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. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
offset |
No |
Integer |
request offset, from 0 |
|
limit |
No |
Integer |
Definition Data volume. Constraints N/A Range N/A Default Value N/A |
|
sort_key |
No |
String |
Definition Sorting field.
Constraints N/A Range
Default Value create_time |
|
sort_dir |
No |
String |
Definition Sorting order.
Constraints N/A Range
Default Value DESC |
Request 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.
Constraints N/A Range
Default Value N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Error code. |
|
data |
Array of WizardDetailInfo objects |
Data list. |
|
message |
String |
Error message |
|
offset |
Integer |
request offset, from 0 |
|
request_id |
String |
Request id |
|
limit |
Integer |
request limit size |
|
success |
Boolean |
Whether the response is successful. |
|
total |
Integer |
tatal count |
|
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. |
|
Parameter |
Type |
Description |
|---|---|---|
|
button_id |
String |
Button ID. |
|
button_name |
String |
Button name. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
|
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 |
Response of listing wizard informations |
|
400 |
Error response |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot