更新时间:2025-08-30 GMT+08:00
分享

全部布局字段

功能介绍

查询布局字段列表

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/workspaces/{workspace_id}/soc/layouts/fields

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间id。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

name

String

名称查询

is_built_in

Boolean

是否内置

business_code

String

数据类业务编码

layout_id

String

布局id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

content-type

String

参数解释:

内容类型

  • application/json;charset=UTF-8 普通API请求的类型

约束限制:

不涉及

取值范围:

  • application/json;charset=UTF-8

默认取值:

不涉及

响应参数

状态码:200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表5 响应Body参数

参数

参数类型

描述

code

String

错误码

data

Array of LayoutFieldResponseBody objects

数据列表

message

String

Error message

offset

Integer

request offset, from 0

request_id

String

Request id

limit

Integer

request limit size

success

Boolean

是否响应成功

total

Integer

tatal count

表6 LayoutFieldResponseBody

参数

参数类型

描述

id

String

Id value

cloud_pack_id

String

订阅包id

cloud_pack_name

String

订阅包名称

dataclass_id

String

dataclass id.

cloud_pack_version

String

订阅包版本

field_key

String

字段key

name

String

字段名称

description

String

字段描述

en_description

String

字段英文描述

default_value

String

默认值

en_default_value

String

字段英文默认值

field_type

String

字段类型,如shorttext,radio,grid等

extra_json

String

附加json

field_tooltip

String

工具提示

en_field_tooltip

String

英文工具提示

json_schema

String

json模式

is_built_in

Boolean

是否内置,true内置,false非内置

read_only

Boolean

只读模式,true只读,false非只读

required

Boolean

是否必填,true必填,false非必填

searchable

Boolean

可搜索,true可搜索,false非可搜索

visible

Boolean

可见,true可见,false非可见

maintainable

Boolean

可维护,true可维护,false非可维护

editable

Boolean

可编辑,true可编辑,false非可编辑

creatable

Boolean

可创建,true可创建,false非可创建

creator_id

String

Creator id value

creator_name

String

Creator name value

modifier_id

String

Modifier id value

modifier_name

String

Modifier name value

create_time

String

Create time

update_time

String

Update time

wizard_id

String

字段绑定的页面id

aopworkflow_id

String

字段绑定的流程id

aopworkflow_version_id

String

字段绑定的流程版本id

playbook_id

String

字段绑定的剧本id

playbook_version_id

String

字段绑定的剧本版本id

boa_version

String

BOA底座版本

version

String

安全云脑版本

状态码:400

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表8 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

响应示例

状态码

状态码

描述

200

请求成功

400

Error response

错误码

请参见错误码

相关文档