文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V1/ 数据类字段/ 创建字段 - CreateField
更新时间：2026-06-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建字段 - CreateField

功能介绍

创建自定义数据类字段

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses/{dataclass_id}/fields

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

workspace_id

是

String

参数解释：

工作空间id

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

dataclass_id

是

String

参数解释：

数据类的唯一ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表2 请求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

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

field_key

是

String

参数解释：

字段键

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

name

是

String

参数解释：

字段名称

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

description

否

String

参数解释：

字段描述

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

default_value

否

String

参数解释：

默认值

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

display_type

否

String

参数解释：

显示类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

field_type

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

readonly

否

Boolean

参数解释：

只读模式，true只读，false非只读

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

required

否

Boolean

参数解释：

是否必填，true必填，false非必填

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

visible

否

Boolean

参数解释：

可见，true可见，false非可见

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

mapping

否

Boolean

参数解释：

是否展示在除分类映射外的其他地方

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释：

字段ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

cloud_pack_version

String

参数解释：

订阅包版本

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

business_id

String

参数解释：

关联业务id

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

business_type

String

参数解释：

关联业务

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

dataclass_name

String

参数解释：

数据类名称

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

business_code

String

参数解释：

业务编码

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

field_key

String

参数解释：

字段键

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

name

String

参数解释：

字段名称

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

description

String

参数解释：

字段描述

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

default_value

String

参数解释：

默认值

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

display_type

String

参数解释：

显示类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

field_type

String

参数解释：

字段类型

约束限制：

不涉及

取值范围：

  • String: 字符串

Object: 对象

Timestamp: 时间

Integer: 整型

List[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]: 字符串数组

Numeric: 数字

Boolean: 布尔值

List[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]: 对象数组

Long: 长整型

Enum: 枚举

Double: 双精度浮点数

Float: 浮点数

Password: 密码

默认取值：

不涉及

extra_json

String

参数解释：

附加json

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

field_tooltip

String

参数解释：

工具提示

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

iu_type

String

参数解释：

输入输出类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

used_by

String

参数解释：

使用业务

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

json_schema

String

参数解释：

json模式

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

is_built_in

Boolean

参数解释：

是否内置，true内置，false非内置

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

case_sensitive

Boolean

参数解释：

大小写敏感，true敏感，false不敏感

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

read_only

Boolean

参数解释：

只读模式，true只读，false非只读

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

required

Boolean

参数解释：

是否必填，true必填，false非必填

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

searchable

Boolean

参数解释：

是否必填，true必填，false非必填

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

visible

Boolean

参数解释：

可见，true可见，false非可见

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

maintainable

Boolean

参数解释：

可维护，true可维护，false非可维护

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

editable

Boolean

参数解释：

可编辑，true可编辑，false非可编辑

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

creatable

Boolean

参数解释：

可编辑，true可编辑，false非可编辑

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

mapping

Boolean

参数解释：

是否展示在分类映射外的其他地方

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

target_api

String

参数解释：

目标api

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

creator_id

String

参数解释：

创建人id

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

creator_name

String

参数解释：

创建人名称

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

modifier_id

String

参数解释：

修改人id

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

modifier_name

String

参数解释：

修改人名称

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

create_time

String

参数解释：

创建时间

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

update_time

String

参数解释：

修改时间

约束限制：

不涉及

取值范围：

  • true

  • false

默认取值：

不涉及

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

error_msg

String

参数解释：

错误描述

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

状态码：500

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

error_msg

String

参数解释：

错误描述

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求示例

新建自定义数据类字段

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses/{dataclass_id}/fields

{
  "field_key" : "kk",
  "name" : "测试字段",
  "field_type" : "String"
}

响应示例

状态码：200

请求成功

{
  "default_value" : "a;b",
  "description" : "新增测试字段",
  "display_type" : "text",
  "field_key" : "test_key",
  "field_type" : "String",
  "id" : "3e94505d-478f-4619-bef9-2c60a9fe3401",
  "mapping" : true,
  "name" : "新增测试字段",
  "required" : false,
  "visible" : true
}

状态码

状态码

描述

200

请求成功

400

请求参数有误

500

请求失败

错误码

请参见错误码。

父主题： 数据类字段

相关文档