批量更新布局页面 - UpdateLayoutWizards
功能介绍
更新页面
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
PUT /v1/{project_id}/workspaces/{workspace_id}/soc/layouts/wizards
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
参数解释: 工作空间id。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
content-type |
是 |
String |
参数解释: 内容类型
约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
layout_wizard_update_pojo_list |
否 |
Array of WizardUpdateRequestPojo objects |
更新页面请求体列表 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
create_time |
否 |
String |
创建时间 |
|
creator_id |
否 |
String |
创建者ID |
|
description |
否 |
String |
描述信息 |
|
id |
否 |
String |
页面ID |
|
wizard_json |
否 |
String |
布局页面相关信息 |
|
name |
否 |
String |
页面名称 |
|
update_time |
否 |
String |
更新时间 |
|
layout_id |
否 |
String |
布局ID |
|
project_id |
否 |
String |
租户ID |
|
workspace_id |
否 |
String |
工作空间ID |
|
is_binding |
否 |
Boolean |
是否已绑定按钮 |
|
binding_button |
否 |
Array of binding_button objects |
绑定按钮 |
|
boa_version |
否 |
String |
BOA底座版本 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
data |
Array of WizardDetailInfo objects |
数据列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
create_time |
String |
创建时间 |
|
creator_id |
String |
创建者ID |
|
description |
String |
描述信息 |
|
en_description |
String |
英文描述 |
|
id |
String |
页面ID |
|
wizard_json |
String |
布局页面相关信息 |
|
name |
String |
页面名称 |
|
en_name |
String |
英文名称 |
|
update_time |
String |
更新时间 |
|
project_id |
String |
租户ID |
|
workspace_id |
String |
工作空间ID |
|
is_binding |
Boolean |
是否已绑定按钮 |
|
binding_button |
Array of binding_button objects |
绑定按钮 |
|
is_built_in |
Boolean |
是否为系统页面 |
|
boa_version |
String |
BOA底座版本 |
|
version |
String |
安全云脑版本 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
更新页面请求体
{
"layout_wizard_update_pojo_list" : [ {
"layout_id" : "8f7b3080-e528-440b-99c6-44252f149643",
"is_binding" : true,
"binding_button" : [ {
"button_name" : "test",
"button_id" : "123"
} ],
"workspace_id" : "d7310f19-56d3-4556-b4ea-328a7899a6ba",
"project_id" : "81fee81ab75a48a7b38e6586868688e7",
"name" : "批量关闭",
"boa_version" : "V3",
"id" : "7f058f3a-f954-4506-80ea-c60872000b1b"
} ]
}
响应示例
状态码:200
更新页面成功响应
{
"code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"data" : [ {
"id" : "7f058f3a-f954-4506-80ea-c60872000b1b",
"name" : "批量关闭",
"workspace_id" : "7f058f3a-f954-4506-80ea-c60872000b1b"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
更新页面成功响应 |
|
400 |
错误响应 |
错误码
请参见错误码。