数据治理中心 DATAARTS STUDIO-创建表模型:请求参数
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
IAM Token |
workspace |
是 |
String |
DataArts Studio 工作空间ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
Long |
编码 |
model_id |
是 |
Long |
模型id |
parent_table_id |
否 |
Long |
父表id |
parent_table_name |
否 |
String |
父表名称 |
parent_table_code |
否 |
String |
父表编码 |
model |
否 |
WorkspaceVO object |
模型 |
data_format |
否 |
String |
数据格式 最大长度:100 |
obs_bucket |
否 |
String |
obs桶 最大长度:200 |
obs_location |
否 |
String |
obs路径 最大长度:2000 |
configs |
否 |
String |
其他配置 最大长度:1024 |
table_type |
否 |
String |
表类型 |
owner |
否 |
String |
最大长度:100 |
tb_name |
是 |
String |
表名 最大长度:400 |
dw_id |
否 |
String |
数据连接id |
db_name |
否 |
String |
数据库名 |
queue_name |
否 |
String |
dli数据连接执行sql所需的队列,数据连接类型为 DLI 时必须 |
schema |
否 |
String |
DWS类型需要 |
extend_info |
否 |
String |
扩展信息 |
tb_guid |
否 |
String |
表物化后的guid |
tb_id |
否 |
String |
数据表id |
logic_tb_name |
是 |
String |
逻辑实体名 最大长度:200 |
logic_tb_guid |
否 |
String |
逻辑实体的guid |
description |
是 |
String |
描述 最大长度:600 |
status |
否 |
String |
业务状态 枚举值:
|
logic_tb_id |
否 |
Long |
逻辑实体的id |
biz_catalog_id |
否 |
Long |
归属的业务分类的id |
catalog_path |
否 |
String |
归属的业务分类的路径 {"l1Id":"","l2Id":"","l3Id":""} |
create_by |
否 |
String |
创建人 |
update_by |
否 |
String |
更新人 |
create_time |
否 |
String |
创建时间 |
update_time |
否 |
String |
更新时间 |
tags |
否 |
Array of TagVO objects |
表标签 |
approval_info |
否 |
ApprovalVO object |
审批信息 |
new_biz |
否 |
BizVersionManageVO object |
业务版本管理. |
attributes |
是 |
Array of TableModelAttributeVO objects |
表属性信息 |
mappings |
否 |
Array of TableMappingVO objects |
表映射信息 |
relations |
否 |
Array of RelationVO objects |
关系 |
dw_type |
是 |
String |
数据连接类型 |
dw_name |
否 |
String |
数据连接名称 |
l1 |
否 |
String |
主题域分组中文名 |
l2 |
否 |
String |
主题域中文名 |
l3 |
否 |
String |
业务对象中文名 |
l1_id |
否 |
Long |
主题域分组id |
l2_id |
否 |
String |
主题域id |
l3_id |
否 |
Long |
业务对象id |
partition_conf |
否 |
String |
分区表达式 |
dlf_task_id |
否 |
String |
DLF 作业 ID |
use_recently_partition |
否 |
Boolean |
是否使用最新分区 缺省值:false |
reversed |
否 |
Boolean |
是否是逆向的 缺省值:false |
dirty_out_switch |
否 |
Boolean |
异常数据输出开关 缺省值:false |
dirty_out_database |
否 |
String |
异常数据输出库 |
dirty_out_prefix |
否 |
String |
异常表前缀 |
dirty_out_suffix |
否 |
String |
异常表后缀 |
quality_owner |
否 |
String |
质量责任人 |
quality_id |
否 |
Long |
质量id |
distribute |
否 |
String |
DISTRIBUTE BY [HASH(column)|REPLICATION] 枚举值:
|
distribute_column |
否 |
String |
DISTRIBUTE BY HASH column |
is_partition |
否 |
Boolean |
是否分区表 缺省值:false |
physical_table |
否 |
String |
创建表状态 枚举值:
|
technical_asset |
否 |
String |
技术资产同步状态 枚举值:
|
business_asset |
否 |
String |
业务资产同步状态 枚举值:
|
meta_data_link |
否 |
String |
资产关联状态 枚举值:
|
data_quality |
否 |
String |
质量作业状态 枚举值:
|
summary_status |
否 |
String |
同步整体状态 枚举值:
|
alias |
否 |
String |
别名 |
self_defined_fields |
否 |
Array of SelfDefinedFieldVO objects |
自定义项 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
Long |
编号 |
name |
是 |
String |
工作区名字 最大长度:250 |
description |
否 |
String |
最大长度:600 |
is_physical |
否 |
Boolean |
是否为物理表 缺省值:true |
frequent |
否 |
Boolean |
是否为常用 缺省值:true |
top |
否 |
Boolean |
分层治理 缺省值:true |
level |
否 |
String |
数据治理 分层 枚举值:
|
dw_type |
否 |
String |
数据连接类型 |
create_time |
否 |
String |
创建时间 |
update_time |
否 |
String |
更新时间 |
create_by |
否 |
String |
创建人 |
update_by |
否 |
String |
更新人 |
type |
是 |
String |
工作区类型枚举 枚举值:
|
biz_catalog_ids |
否 |
String |
关联的业务分层的id列表 {"l1Ids":[],"l2Ids":[],"l3Ids":[]} |
databases |
否 |
Array of strings |
数据库名称数组 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
Long |
ID |
tenant_id |
否 |
String |
tenant id |
name_ch |
否 |
String |
业务中文名 |
name_en |
否 |
String |
业务英文名 |
biz_id |
否 |
Long |
业务ID |
biz_type |
否 |
String |
业务类型 枚举值:
|
biz_info |
否 |
String |
业务详情 |
biz_info_obj |
否 |
Object |
业务详情 |
biz_version |
否 |
Integer |
业务版本 |
biz_status |
否 |
String |
业务状态 枚举值:
|
approval_status |
否 |
String |
业务审批状态 枚举值:
|
approval_type |
否 |
String |
业务审核类型 枚举值:
|
submit_time |
否 |
String |
提交时间 |
create_by |
否 |
String |
创建者 |
l1 |
否 |
String |
主题域分组 |
l2 |
否 |
String |
主题域 |
l3 |
否 |
String |
业务对象 |
approval_time |
否 |
String |
审核时间 |
approver |
否 |
String |
审核人 |
否 |
String |
审核人邮箱 |
|
msg |
否 |
String |
审核信息 |
directory_path |
否 |
String |
目录树 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
Long |
编码 |
name_en |
是 |
String |
字段名 最大长度:600 |
name_ch |
是 |
String |
业务属性 最大长度:200 |
description |
否 |
String |
最大长度:600 |
obs_location |
否 |
String |
obs路径,子路径 最大长度:600 |
create_by |
否 |
String |
创建人 |
update_by |
否 |
String |
更新人 |
data_type |
是 |
String |
字段类型 |
domain_type |
否 |
String |
字段类型所属域 枚举值:
|
data_type_extend |
否 |
String |
数据类型扩展字段 最大长度:50 |
is_primary_key |
是 |
Boolean |
是否主键 缺省值:false |
is_partition_key |
否 |
Boolean |
是否分区键 缺省值:false |
is_foreign_key |
否 |
Boolean |
是否外键 缺省值:false |
extend_field |
否 |
Boolean |
是否继承的属性 缺省值:false |
not_null |
否 |
Boolean |
是否不为空 缺省值:false |
ordinal |
否 |
Integer |
序号 |
table_model_id |
否 |
Long |
所属表模型id |
create_time |
否 |
String |
创建时间 |
update_time |
否 |
String |
更新时间 |
tags |
否 |
Array of TagVO objects |
表标签 |
stand_row_id |
否 |
Long |
关联的数据标准的id |
stand_row_name |
否 |
String |
最大长度:600 |
quality_infos |
否 |
Array of QualityInfoVO objects |
质量信息 |
alias |
否 |
String |
别名 |
self_defined_fields |
否 |
Array of SelfDefinedFieldVO objects |
自定义项 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
Long |
编码 |
name |
是 |
String |
标签名 最大长度:250 |
description |
否 |
String |
最大长度:600 |
create_by |
否 |
String |
创建人 |
update_by |
否 |
String |
更新人 |
create_time |
否 |
String |
创建时间 |
update_time |
否 |
String |
更新时间 |
new_biz |
否 |
BizVersionManageVO object |
业务版本管理. |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
Long |
ID信息 |
biz_type |
否 |
String |
业务类型 枚举值:
|
biz_id |
否 |
Long |
业务id |
biz_info |
否 |
String |
业务对象信息 |
status |
否 |
String |
业务状态 枚举值:
|
biz_version |
否 |
Integer |
业务版本 |
create_time |
否 |
String |
创建时间 |
update_time |
否 |
String |
更新时间 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
Long |
编码 |
table_id |
否 |
Long |
表id |
attr_id |
否 |
Long |
属性id |
biz_type |
否 |
String |
业务类型 枚举值:
|
data_quality_id |
是 |
Long |
质量id |
show_control |
否 |
Integer |
是否要显示 正则表达式 |
data_quality_name |
否 |
String |
质量名称 |
alert_conf |
否 |
String |
告警配置 |
expression |
否 |
String |
正则相关校验规则中正则配置 |
extend_info |
否 |
String |
扩展信息 |
from_standard |
否 |
Boolean |
是否来源于数据标准质量配置 缺省值:false |
result_description |
否 |
String |
结果说明 |
create_by |
否 |
String |
创建人 |
update_by |
否 |
String |
更新人 |
create_time |
否 |
String |
创建时间 |
update_time |
否 |
String |
更新时间 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
Long |
编码 |
name |
是 |
String |
名称 |
description |
否 |
String |
最大长度:600 |
target_table_id |
否 |
Long |
目的表id |
src_model_id |
否 |
Long |
来源表所属模型id |
src_model_name |
否 |
String |
来源模型名称 |
view_text |
否 |
String |
采集的视图来源,dws视图逆向使用 |
target_table_name |
否 |
String |
目的表名称 |
details |
否 |
Array of TableMappingDetailVO objects |
详情 |
source_tables |
否 |
Array of MappingSourceTableVO objects |
映射的表信息 |
source_fields |
否 |
Array of MappingSourceFieldVO objects |
映射的字段信息 |
create_time |
否 |
String |
创建时间 |
update_time |
否 |
String |
更新时间 |
create_by |
否 |
String |
创建人 |
update_by |
否 |
String |
更新人 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
Long |
编码 |
mapping_id |
否 |
String |
名称 |
target_attr_id |
否 |
Long |
目的字段id |
target_attr_name |
是 |
String |
目的字段排序 |
src_table_ids |
否 |
String |
源表id, 通过,join |
src_table_names |
否 |
Array of strings |
源表名称数组 |
src_table_db_names |
否 |
Array of strings |
源表db名称数组 |
src_table_model_ids |
否 |
Array of longs |
源表模型id数组 |
src_table_id_list |
否 |
Array of longs |
源表id数组 |
src_attr_ids |
否 |
String |
源表字段id, 通过,join |
src_attr_names |
否 |
Array of strings |
源表字段名称数组 |
src_attr_id_list |
否 |
Array of longs |
源表字段id数组 |
remark |
否 |
String |
备注 |
create_time |
否 |
String |
创建时间 |
update_time |
否 |
String |
更新时间 |
create_by |
否 |
String |
创建人 |
update_by |
否 |
String |
更新人 |
target_attr |
否 |
Object |
目标属性 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
table1_id |
是 |
Long |
表id |
table2_id |
否 |
Long |
表id 缺省值:0 |
table1_name |
是 |
String |
表1名称 |
table2_name |
否 |
String |
表2名称 |
join_type |
是 |
String |
关联类型,左外连接,右外连接,内连接,全连接 缺省值:LEFT 枚举值:
|
join_fields |
是 |
Array of MappingJoinFieldVO objects |
on条件 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
field1_id |
是 |
Long |
属性id |
field2_id |
是 |
Long |
属性id |
field1_name |
是 |
String |
名称 |
field2_name |
是 |
String |
名称 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
target_field_id |
否 |
Long |
目标字段ID,当前表的某个字段 |
target_field_name |
是 |
String |
目标字段编码 |
field_ids |
否 |
String |
来源字段id,多个id以逗号分隔 |
transform_expression |
否 |
String |
转换表达式 |
field_names |
否 |
Array of strings |
来源字段名称列表 |
changed |
否 |
Boolean |
字段是否发生变化 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
Long |
编码 |
source_table_id |
否 |
Long |
源表id |
target_table_id |
否 |
Long |
目标表id |
name |
是 |
String |
关系名称 |
source_table_name |
否 |
String |
源表名称 |
target_table_name |
否 |
String |
目的表名称 |
role |
否 |
String |
角色 |
tenant_id |
否 |
String |
租户id |
source_type |
否 |
String |
关系类型 枚举值:
|
target_type |
否 |
String |
关系类型 枚举值:
|
create_by |
否 |
String |
创建人 |
update_by |
否 |
String |
更新人 |
create_time |
否 |
String |
创建时间 |
update_time |
否 |
String |
更新时间 |
mappings |
否 |
Array of RelationMappingVO objects |
表属性信息 |