创建字段 - CreateField

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

workspace_id

是

String

参数解释：

工作空间ID，用于指定操作的工作空间范围。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

获取方式：

可通过调用查询数据类列表接口获取，也可从控制台获取。

dataclass_id

是

String

参数解释：

数据类的唯一ID，用于指定操作的数据类。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

获取方式：

可通过调用查询数据类列表接口获取，也可从控制台获取。

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

content-type

是

String

参数解释：

请求体的内容类型，用于指定请求体的媒体类型

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

field_key

是

String

参数解释：

字段键，用于在数据类中唯一标识和引用该字段

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

name

是

String

参数解释：

字段名称

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

description

否

String

参数解释：

字段描述

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

default_value

否

String

参数解释：

默认值

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

display_type

否

String

参数解释：

显示类型，用于控制字段在界面上的显示形式，如文本框、下拉框等

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

field_type

是

String

参数解释：

字段类型

约束限制：

不涉及

取值范围：

• String: 字符串

• Object: 对象

• Timestamp: 时间

• Integer: 整型

• Long: 长整型

• Numeric: 数字

• Double: 双精度浮点数

• Float: 浮点数

• Boolean: 布尔值

• Enum: 枚举

• Password: 密码

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

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

默认取值：

不涉及

readonly

否

Boolean

参数解释：

是否只读

约束限制：

不涉及

取值范围：

• true：只读

• false：非只读

默认取值：

不涉及

required

否

Boolean

参数解释：

是否必填

约束限制：

不涉及

取值范围：

• true：必填

• false：非必填

默认取值：

不涉及

visible

否

Boolean

参数解释：

是否可见

约束限制：

不涉及

取值范围：

• true：可见

• false：非可见

默认取值：

不涉及

mapping

否

Boolean

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

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: 整型

• Long: 长整型

• Numeric: 数字

• Double: 双精度浮点数

• Float: 浮点数

• Boolean: 布尔值

• Enum: 枚举

• Password: 密码

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

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

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：非可见

maintainable

Boolean

参数解释：

是否可维护

取值范围：

• true：可维护

• false：非可维护

editable

Boolean

参数解释：

是否可编辑

取值范围：

• true：可编辑

• false：非可编辑

creatable

Boolean

参数解释：

是否可创建，true可创建，false不可创建

取值范围：

• true

• false

mapping

Boolean

参数解释：

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

取值范围：

• true

• false

target_api

String

参数解释：

目标api

取值范围：

不涉及

creator_id

String

参数解释：

创建人id

取值范围：

不涉及

creator_name

String

参数解释：

创建人名称

取值范围：

不涉及

modifier_id

String

参数解释：

修改人id

取值范围：

不涉及

modifier_name

String

参数解释：

修改人名称

取值范围：

不涉及

create_time

String

参数解释：

创建时间，格式为yyyy-MM-ddTHH:mm:ssZ+0800

取值范围：

不涉及

update_time

String

参数解释：

修改时间，格式为yyyy-MM-ddTHH:mm:ssZ+0800

取值范围：

不涉及

error_code

String

参数解释：

错误码

取值范围：

不涉及

error_msg

String

参数解释：

错误描述

取值范围：

不涉及

error_code

String

参数解释：

错误码

取值范围：

不涉及

error_msg

String

参数解释：

错误描述

取值范围：

不涉及

200

请求成功

400

请求参数有误

500

请求失败