文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据架构API/ 维度接口/ 更新维度

更新时间：2024-11-22 GMT+08:00

在线调试

CLI示例

查看PDF

更新维度

功能介绍

根据参数，更新维度信息。

调用方法

请参见如何调用API。

URI

PUT /v2/{project_id}/design/dimensions

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方法请参见项目ID和账号ID。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
id	否	String	编码（新建时只读，更新时必填），ID字符串。
name_en	是	String	维度英文名称。
dimension_type	是	String	维度类型（更新时只能由普通维度改为层级维度，其余场景都不允许修改）。枚举值： COMMON: 普通维度 LOOKUP: 码表维度 HIERARCHIES: 层级维度
name_ch	是	String	维度名称。
description	是	String	描述。
create_by	否	String	创建人。
update_by	否	String	更新人。
code_table_id	否	String	引用码表ID（新建/更新“码表维度”时必填），ID字符串。
l2_id	否	String	主题域ID。
l3_id	是	String	业务对象ID，ID字符串。
hierarchies	否	Array of DimensionHierarchiesVO objects	层级属性。
status	否	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
approval_info	否	ApprovalVO object	审批信息,只读参数。业务对象最近一次的审批信息，包括审批的业务详情、审核人信息、审核时间等。
l1	否	String	主题域分组中文名，只读，创建和更新时无需填写。
l2	否	String	主题域中文名，只读，创建和更新时无需填写。
l3	否	String	业务对象中文名，只读，创建和更新时无需填写。
attributes	是	Array of DimensionAttributeVO objects	维度属性信息。
mappings	否	Array of TableMappingVO objects	表映射信息。
datasource	是	BizDatasourceRelationVO object	数据源信息，新建/更新时必填。
owner	是	String	资产责任人，新建/更新时必填。
obs_location	否	String	外表路径
table_type	否	String	表类型。
distribute	否	String	DISTRIBUTE BY [HASH(column)\|REPLICATION]。枚举值： HASH: 对指定的列进行Hash，通过映射，把数据分布到指定DN REPLICATION: 表的每一行存在所有数据节点（DN）中，即每个数据节点都有完整的表数据
distribute_column	否	String	DISTRIBUTE BY HASH column.
alias	否	String	别名。
self_defined_fields	否	Array of SelfDefinedFieldVO objects	自定义项。
configs	否	String	其他配置
model_id	否	String	所属模型ID
model	否	WorkspaceVO object	模型信息。

表3 DimensionHierarchiesVO
参数	是否必选	参数类型	描述
id	否	String	编码，ID字符串。
name	否	String	层级名称。
attrs	否	Array of HierarchiesAttrVO objects	层级包含的属性。
create_by	否	String	创建人。
update_by	否	String	更新人。

表4 HierarchiesAttrVO
参数	是否必选	参数类型	描述
id	否	String	编码，ID字符串。
hierarchies_id	否	String	层级ID，ID字符串。
attr_id	否	String	属性ID，ID字符串。
level	否	Integer	层次。
attr_name_en	否	String	引用属性编码。
detail_attr_ids	否	Array of strings	详情属性ID，ID字符串。
detail_attr_name_ens	否	Array of strings	详情属性英文。

表5 ApprovalVO
参数	是否必选	参数类型	描述
id	否	String	审批单ID，ID字符串。
tenant_id	否	String	项目ID，获取方式参考接口路径参数“project_id”。
name_ch	否	String	业务中文名。
name_en	否	String	业务英文名。
biz_id	否	String	业务ID，ID字符串。
biz_type	否	String	业务实体类型。枚举值： AGGREGATION_LOGIC_TABLE: 汇总表 ATOMIC_INDEX: 原子指标 ATOMIC_METRIC: 原子指标（新） BIZ_CATALOG: 流程架构目录 BIZ_METRIC: 业务指标 CODE_TABLE: 码表 COMMON_CONDITION: 通用限定 COMPOSITE_METRIC: 复合指标（新） COMPOUND_METRIC: 复合指标 CONDITION_GROUP: 限定分组 DEGENERATE_DIMENSION: 退化维度 DERIVATIVE_INDEX: 衍生指标 DERIVED_METRIC: 衍生指标（新） DIMENSION: 维度 DIMENSION_ATTRIBUTE: 维度属性 DIMENSION_HIERARCHIES: 维度层级 DIMENSION_LOGIC_TABLE: 维度表 DIMENSION_TABLE_ATTRIBUTE: 维度属性 DIRECTORY: 目录 FACT_ATTRIBUTE: 事实表属性 FACT_DIMENSION: 事实表维度 FACT_LOGIC_TABLE: 事实表 FACT_MEASURE: 事实表度量 FUNCTION: 函数 INFO_ARCH: 信息架构（批量修改主题使用） MODEL: 模型 QUALITY_RULE: 质量规则 SECRECY_LEVEL: 密级 STANDARD_ELEMENT: 数据标准 STANDARD_ELEMENT_TEMPLATE: 数据标准模板 SUBJECT: 主题 SUMMARY_DIMENSION_ATTRIBUTE: 汇总表维度属性 SUMMARY_INDEX: 汇总表指标属性 SUMMARY_TIME: 汇总表时间周期属性 TABLE_MODEL: 关系模型（逻辑模型/物理模型） TABLE_MODEL_ATTRIBUTE: 关系模型属性（逻辑模型/物理模型） TABLE_MODEL_LOGIC: 逻辑实体 TABLE_TYPE: 表类型 TAG: 标签 TIME_CONDITION: 时间限定
biz_info	否	String	序列化之后的业务详情，类型是string。
biz_info_obj	否	Object	业务详情，类型是object。
biz_version	否	Integer	业务版本。
biz_status	否	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
approval_status	否	String	业务审批状态，只读。枚举值： DEVELOPING: 审核中 APPROVED: 审核通过 REJECT: 审核驳回 WITHDREW: 审核撤销
approval_type	否	String	业务审核类型。枚举值： PUBLISH: 发布 OFFLINE: 下线
submit_time	否	String	提交时间。
create_by	否	String	创建者。
l1	否	String	主题域分组中文名，只读，创建和更新时无需填写。
l2	否	String	主题域中文名，只读，创建和更新时无需填写。
l3	否	String	业务对象中文名，只读，创建和更新时无需填写。
approval_time	否	String	审核时间。
approver	否	String	审核人。
email	否	String	审核人邮箱。
msg	否	String	审核信息。
directory_path	否	String	目录树。

表6 DimensionAttributeVO
参数	是否必选	参数类型	描述
id	否	String	编码，ID字符串。
code_table_field_id	否	String	码表属性ID，ID字符串。
name_en	是	String	字段名。
name_ch	是	String	业务属性。
description	否	String	描述。
create_by	否	String	创建人。
data_type	是	String	字段类型。
data_type_extend	否	String	数据类型扩展字段。
is_primary_key	是	Boolean	是否主键。
is_biz_primary	否	Boolean	是否业务主键。
is_partition_key	否	Boolean	是否分区。
ordinal	是	Integer	序号。
not_null	否	Boolean	是否不为空。
stand_row_id	否	String	关联的数据标准的ID，ID字符串。
status	否	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
alias	否	String	别名
self_defined_fields	否	Array of SelfDefinedFieldVO objects	自定义项。

表7 TableMappingVO
参数	是否必选	参数类型	描述
id	否	String	编码，ID字符串。
name	是	String	名称。
description	否	String	描述。
target_table_id	否	String	目的表ID，ID字符串。
src_model_id	否	String	来源表在关系建模中的模型ID，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	创建时间，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
update_time	否	String	更新时间，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
create_by	否	String	创建人。
update_by	否	String	更新人。

表8 TableMappingDetailVO
参数	是否必选	参数类型	描述
id	否	String	编码，ID字符串。
mapping_id	否	String	名称。
target_attr_id	否	String	目的字段ID，ID字符串。
target_attr_name	是	String	目的字段排序。
src_table_ids	否	String	源表ID。
src_attr_ids	否	String	源表字段ID。
remark	否	String	备注。
create_time	否	String	创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
update_time	否	String	更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
create_by	否	String	创建人。
update_by	否	String	更新人。
target_attr	否	Object	目标属性。

表9 MappingSourceTableVO
参数	是否必选	参数类型	描述
table1_id	是	String	表1ID，ID字符串。
table2_id	否	String	表2ID，ID字符串。
table1_name	是	String	表1名称。
table2_name	否	String	表2名称。
join_type	是	String	关联类型。枚举值： LEFT: 左外连接 RIGHT: 右外连接 INNER: 内连接 FULL: 全连接
join_fields	是	Array of MappingJoinFieldVO objects	on条件。

**表10** MappingJoinFieldVO
参数	是否必选	参数类型	描述
field1_id	是	String	属性1ID，ID字符串。
field2_id	是	String	属性2ID，ID字符串。
field1_name	是	String	属性1名称。
field2_name	是	String	属性2名称。

**表11** MappingSourceFieldVO
参数	是否必选	参数类型	描述
target_field_id	否	String	目标字段ID，当前表的某个字段，ID字符串。
target_field_name	是	String	目标字段编码。
field_ids	否	String	来源字段ID，多个ID以逗号分隔。
transform_expression	否	String	转换表达式。
field_names	否	Array of strings	来源字段名称列表。
changed	否	Boolean	字段是否发生变化。

**表12** BizDatasourceRelationVO
参数	是否必选	参数类型	描述
id	否	String	编码，ID字符串。
biz_id	否	String	业务对象信息，ID字符串。
biz_type	否	String	业务对象类型。
dw_type	是	String	数据连接类型，对应表所在的数仓类型，取值可以为DWS、MRS_HIVE、POSTGRESQL、MRS_SPARK、CLICKHOUSE、MYSQL、ORACLE和DORIS等。
dw_id	是	String	数据连接ID。
db_name	否	String	数据库名。
queue_name	否	String	dli数据连接执行sql所需的队列，数据连接类型为DLI时必须。
schema	否	String	DWS类型需要。

**表13** SelfDefinedFieldVO
参数	是否必选	参数类型	描述
fd_name_ch	否	String	自定义项中文名。
fd_name_en	否	String	自定义项英文名。
not_null	否	Boolean	是否必填。
fd_value	否	String	属性值。

**表14** WorkspaceVO
参数	是否必选	参数类型	描述
id	否	String	编号，ID字符串。
name	是	String	工作区名字。
description	否	String	描述。
is_physical	否	Boolean	是否为物理表。
frequent	否	Boolean	是否为常用。
top	否	Boolean	分层治理。
level	否	String	数据治理分层。枚举值： SDI: 贴源数据层 DWI: 数据整合层 DWR: 数据报告层 DM: 数据集市层
dw_type	否	String	数据连接类型，对应表所在的数仓类型，取值可以为DWS、MRS_HIVE、POSTGRESQL、MRS_SPARK、CLICKHOUSE、MYSQL、ORACLE和DORIS等。
create_by	否	String	创建人。
update_by	否	String	更新人。
type	是	String	工作区类型枚举。枚举值： THIRD_NF: 关系建模 DIMENSION: 维度建模
biz_catalog_ids	否	String	关联的业务分层的ID列表 {"l1Ids":[],"l2Ids":[],"l3Ids":[]}。
databases	否	Array of strings	数据库名称数组。
table_model_prefix	否	String	模型校验前缀，长度不超过100，数字字母下划线组成，字母开头

响应参数

状态码： 200

**表15** 响应Body参数
参数	参数类型	描述
data	data object	data，统一的返回结果的最外层数据结构。

**表16** data
参数	参数类型	描述
value	DimensionVO object	value，统一的返回结果的外层数据结构。

**表17** DimensionVO
参数	参数类型	描述
id	String	编码（新建时只读，更新时必填），ID字符串。
name_en	String	维度英文名称。
dimension_type	String	维度类型（更新时只能由普通维度改为层级维度，其余场景都不允许修改）。枚举值： COMMON: 普通维度 LOOKUP: 码表维度 HIERARCHIES: 层级维度
name_ch	String	维度名称。
description	String	描述。
create_by	String	创建人。
update_by	String	更新人。
code_table_id	String	引用码表ID（新建/更新“码表维度”时必填），ID字符串。
code_table	CodeTableVO object	引用码表，只读。
l1_id	String	主题域分组ID，只读，ID字符串。
l2_id	String	主题域ID。
l3_id	String	业务对象ID，ID字符串。
hierarchies	Array of DimensionHierarchiesVO objects	层级属性。
status	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
create_time	String	创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
update_time	String	更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
approval_info	ApprovalVO object	审批信息,只读参数。业务对象最近一次的审批信息，包括审批的业务详情、审核人信息、审核时间等。
new_biz	BizVersionManageVO object	业务版本管理，只读。
l1	String	主题域分组中文名，只读，创建和更新时无需填写。
l2	String	主题域中文名，只读，创建和更新时无需填写。
l3	String	业务对象中文名，只读，创建和更新时无需填写。
attributes	Array of DimensionAttributeVO objects	维度属性信息。
mappings	Array of TableMappingVO objects	表映射信息。
datasource	BizDatasourceRelationVO object	数据源信息，新建/更新时必填。
owner	String	资产责任人，新建/更新时必填。
obs_location	String	外表路径
table_type	String	表类型。
distribute	String	DISTRIBUTE BY [HASH(column)\|REPLICATION]。枚举值： HASH: 对指定的列进行Hash，通过映射，把数据分布到指定DN REPLICATION: 表的每一行存在所有数据节点（DN）中，即每个数据节点都有完整的表数据
distribute_column	String	DISTRIBUTE BY HASH column.
alias	String	别名。
self_defined_fields	Array of SelfDefinedFieldVO objects	自定义项。
configs	String	其他配置
dev_version	String	开发环境版本，只读，ID字符串。
prod_version	String	生产环境版本，只读，ID字符串。
dev_version_name	String	开发环境版本名称，只读。
prod_version_name	String	生产环境版本名称，只读。
env_type	String	开发生产环境类型。枚举值： INVALID_TYPE: 无效环境 DEV_TYPE: 开发环境 PROD_TYPE: 生产环境 DEV_PROD_TYPE: 开发生产环境
model_id	String	所属模型ID
model	WorkspaceVO object	模型信息。

**表18** CodeTableVO
参数	参数类型	描述
id	String	码表ID，ID字符串。
name_en	String	表名称，英文名。
name_ch	String	表名称，中文名。
tb_version	Integer	表版本。
directory_id	String	目录ID，ID字符串。
directory_path	String	目录树。
description	String	描述。
create_by	String	创建人。
status	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
create_time	String	创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
update_time	String	更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
approval_info	ApprovalVO object	审批信息,只读参数。业务对象最近一次的审批信息，包括审批的业务详情、审核人信息、审核时间等。
new_biz	BizVersionManageVO object	业务版本管理，只读。
code_table_fields	Array of CodeTableFieldVO objects	码表属性信息。

**表19** CodeTableFieldVO
参数	参数类型	描述
id	String	码表字段ID，ID字符串。
code_table_id	String	所属码表ID（更新时必填），ID字符串。
ordinal	Integer	序号。
name_en	String	字段名，英文。
name_ch	String	字段名，中文。
description	String	描述。
data_type	String	字段类型。
domain_type	String	字段类型所属域。枚举值： NUMBER: 数字类型 STRING: 字符类型 DATETIME: 日期类型 BLOB: 大对象(BLOB) OTHER: 其它类型
data_type_extend	String	数据类型扩展字段。
is_unique_key	Boolean	是否唯一。
code_table_field_values	Array of CodeTableFieldValueVO objects	码表属性值。
count_field_values	Integer	码表属性值总数。

**表20** CodeTableFieldValueVO
参数	参数类型	描述
id	String	码表字段ID，ID字符串。
fd_id	String	所属码表属性ID，ID字符串。
fd_value	String	码表属性值。
ordinal	Integer	序号。
description	String	描述。

**表21** DimensionHierarchiesVO
参数	参数类型	描述
id	String	编码，ID字符串。
name	String	层级名称。
attrs	Array of HierarchiesAttrVO objects	层级包含的属性。
create_time	String	创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
update_time	String	更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
create_by	String	创建人。
update_by	String	更新人。

**表22** HierarchiesAttrVO
参数	参数类型	描述
id	String	编码，ID字符串。
hierarchies_id	String	层级ID，ID字符串。
attr_id	String	属性ID，ID字符串。
level	Integer	层次。
attr_name_en	String	引用属性编码。
attr_name_ch	String	引用属性名称，只读。
detail_attr_ids	Array of strings	详情属性ID，ID字符串。
detail_attr_name_ens	Array of strings	详情属性英文。
detail_attr_name_chs	Array of strings	详情属性中文，只读。
attr	DimensionAttributeVO object	引用属性字段，只读。
detail_attrs	Array of DimensionAttributeVO objects	详情字段，只读。

**表23** DimensionAttributeVO
参数	参数类型	描述
id	String	编码，ID字符串。
dimension_id	String	维度ID，只读，ID字符串。
code_table_field_id	String	码表属性ID，ID字符串。
name_en	String	字段名。
name_ch	String	业务属性。
description	String	描述。
create_by	String	创建人。
data_type	String	字段类型。
domain_type	String	字段类型所属域。枚举值： NUMBER: 数字类型 STRING: 字符类型 DATETIME: 日期类型 BLOB: 大对象(BLOB) OTHER: 其它类型
data_type_extend	String	数据类型扩展字段。
is_primary_key	Boolean	是否主键。
is_biz_primary	Boolean	是否业务主键。
is_partition_key	Boolean	是否分区。
ordinal	Integer	序号。
not_null	Boolean	是否不为空。
stand_row_id	String	关联的数据标准的ID，ID字符串。
stand_row_name	String	关联的数据标准名称，只读。
quality_infos	Array of QualityInfoVO objects	质量信息，只读。
secrecy_levels	Array of SecrecyLevelVO objects	密级
status	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
create_time	String	创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
update_time	String	更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
alias	String	别名
self_defined_fields	Array of SelfDefinedFieldVO objects	自定义项。

**表24** ApprovalVO
参数	参数类型	描述
id	String	审批单ID，ID字符串。
tenant_id	String	项目ID，获取方式参考接口路径参数“project_id”。
name_ch	String	业务中文名。
name_en	String	业务英文名。
biz_id	String	业务ID，ID字符串。
biz_type	String	业务实体类型。枚举值： AGGREGATION_LOGIC_TABLE: 汇总表 ATOMIC_INDEX: 原子指标 ATOMIC_METRIC: 原子指标（新） BIZ_CATALOG: 流程架构目录 BIZ_METRIC: 业务指标 CODE_TABLE: 码表 COMMON_CONDITION: 通用限定 COMPOSITE_METRIC: 复合指标（新） COMPOUND_METRIC: 复合指标 CONDITION_GROUP: 限定分组 DEGENERATE_DIMENSION: 退化维度 DERIVATIVE_INDEX: 衍生指标 DERIVED_METRIC: 衍生指标（新） DIMENSION: 维度 DIMENSION_ATTRIBUTE: 维度属性 DIMENSION_HIERARCHIES: 维度层级 DIMENSION_LOGIC_TABLE: 维度表 DIMENSION_TABLE_ATTRIBUTE: 维度属性 DIRECTORY: 目录 FACT_ATTRIBUTE: 事实表属性 FACT_DIMENSION: 事实表维度 FACT_LOGIC_TABLE: 事实表 FACT_MEASURE: 事实表度量 FUNCTION: 函数 INFO_ARCH: 信息架构（批量修改主题使用） MODEL: 模型 QUALITY_RULE: 质量规则 SECRECY_LEVEL: 密级 STANDARD_ELEMENT: 数据标准 STANDARD_ELEMENT_TEMPLATE: 数据标准模板 SUBJECT: 主题 SUMMARY_DIMENSION_ATTRIBUTE: 汇总表维度属性 SUMMARY_INDEX: 汇总表指标属性 SUMMARY_TIME: 汇总表时间周期属性 TABLE_MODEL: 关系模型（逻辑模型/物理模型） TABLE_MODEL_ATTRIBUTE: 关系模型属性（逻辑模型/物理模型） TABLE_MODEL_LOGIC: 逻辑实体 TABLE_TYPE: 表类型 TAG: 标签 TIME_CONDITION: 时间限定
biz_info	String	序列化之后的业务详情，类型是string。
biz_info_obj	Object	业务详情，类型是object。
biz_version	Integer	业务版本。
biz_status	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
approval_status	String	业务审批状态，只读。枚举值： DEVELOPING: 审核中 APPROVED: 审核通过 REJECT: 审核驳回 WITHDREW: 审核撤销
approval_type	String	业务审核类型。枚举值： PUBLISH: 发布 OFFLINE: 下线
submit_time	String	提交时间。
create_by	String	创建者。
l1	String	主题域分组中文名，只读，创建和更新时无需填写。
l2	String	主题域中文名，只读，创建和更新时无需填写。
l3	String	业务对象中文名，只读，创建和更新时无需填写。
approval_time	String	审核时间。
approver	String	审核人。
email	String	审核人邮箱。
msg	String	审核信息。
directory_path	String	目录树。

**表25** QualityInfoVO
参数	参数类型	描述
id	String	编码ID，ID字符串。
table_id	String	表ID，只读，ID字符串。
attr_id	String	属性ID，只读，ID字符串。
biz_type	String	业务实体类型。枚举值： AGGREGATION_LOGIC_TABLE: 汇总表 ATOMIC_INDEX: 原子指标 ATOMIC_METRIC: 原子指标（新） BIZ_CATALOG: 流程架构目录 BIZ_METRIC: 业务指标 CODE_TABLE: 码表 COMMON_CONDITION: 通用限定 COMPOSITE_METRIC: 复合指标（新） COMPOUND_METRIC: 复合指标 CONDITION_GROUP: 限定分组 DEGENERATE_DIMENSION: 退化维度 DERIVATIVE_INDEX: 衍生指标 DERIVED_METRIC: 衍生指标（新） DIMENSION: 维度 DIMENSION_ATTRIBUTE: 维度属性 DIMENSION_HIERARCHIES: 维度层级 DIMENSION_LOGIC_TABLE: 维度表 DIMENSION_TABLE_ATTRIBUTE: 维度属性 DIRECTORY: 目录 FACT_ATTRIBUTE: 事实表属性 FACT_DIMENSION: 事实表维度 FACT_LOGIC_TABLE: 事实表 FACT_MEASURE: 事实表度量 FUNCTION: 函数 INFO_ARCH: 信息架构（批量修改主题使用） MODEL: 模型 QUALITY_RULE: 质量规则 SECRECY_LEVEL: 密级 STANDARD_ELEMENT: 数据标准 STANDARD_ELEMENT_TEMPLATE: 数据标准模板 SUBJECT: 主题 SUMMARY_DIMENSION_ATTRIBUTE: 汇总表维度属性 SUMMARY_INDEX: 汇总表指标属性 SUMMARY_TIME: 汇总表时间周期属性 TABLE_MODEL: 关系模型（逻辑模型/物理模型） TABLE_MODEL_ATTRIBUTE: 关系模型属性（逻辑模型/物理模型） TABLE_MODEL_LOGIC: 逻辑实体 TABLE_TYPE: 表类型 TAG: 标签 TIME_CONDITION: 时间限定
data_quality_id	String	质量ID，ID字符串。
show_control	Integer	是否要显示正则表达式。
data_quality_name	String	质量名称。
alert_conf	String	告警配置。
expression	String	正则相关校验规则中正则配置。
extend_info	String	扩展信息。
from_standard	Boolean	是否来源于数据标准质量配置，只读。
result_description	String	结果说明。
create_by	String	创建人，只读。
update_by	String	更新人，只读。
create_time	String	创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
update_time	String	更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。

**表26** SecrecyLevelVO
参数	参数类型	描述
id	String	密级ID，ID字符串。
uuid	String	数据安全主键。
name	String	密级名。
slevel	Integer	密级等级。
description	String	密级描述。
create_by	String	创建人。
update_by	String	更新人。
create_time	String	创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
update_time	String	更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
new_biz	BizVersionManageVO object	业务版本管理，只读。

**表27** BizVersionManageVO
参数	参数类型	描述
id	String	ID信息，ID字符串。
biz_type	String	业务实体类型。枚举值： AGGREGATION_LOGIC_TABLE: 汇总表 ATOMIC_INDEX: 原子指标 ATOMIC_METRIC: 原子指标（新） BIZ_CATALOG: 流程架构目录 BIZ_METRIC: 业务指标 CODE_TABLE: 码表 COMMON_CONDITION: 通用限定 COMPOSITE_METRIC: 复合指标（新） COMPOUND_METRIC: 复合指标 CONDITION_GROUP: 限定分组 DEGENERATE_DIMENSION: 退化维度 DERIVATIVE_INDEX: 衍生指标 DERIVED_METRIC: 衍生指标（新） DIMENSION: 维度 DIMENSION_ATTRIBUTE: 维度属性 DIMENSION_HIERARCHIES: 维度层级 DIMENSION_LOGIC_TABLE: 维度表 DIMENSION_TABLE_ATTRIBUTE: 维度属性 DIRECTORY: 目录 FACT_ATTRIBUTE: 事实表属性 FACT_DIMENSION: 事实表维度 FACT_LOGIC_TABLE: 事实表 FACT_MEASURE: 事实表度量 FUNCTION: 函数 INFO_ARCH: 信息架构（批量修改主题使用） MODEL: 模型 QUALITY_RULE: 质量规则 SECRECY_LEVEL: 密级 STANDARD_ELEMENT: 数据标准 STANDARD_ELEMENT_TEMPLATE: 数据标准模板 SUBJECT: 主题 SUMMARY_DIMENSION_ATTRIBUTE: 汇总表维度属性 SUMMARY_INDEX: 汇总表指标属性 SUMMARY_TIME: 汇总表时间周期属性 TABLE_MODEL: 关系模型（逻辑模型/物理模型） TABLE_MODEL_ATTRIBUTE: 关系模型属性（逻辑模型/物理模型） TABLE_MODEL_LOGIC: 逻辑实体 TABLE_TYPE: 表类型 TAG: 标签 TIME_CONDITION: 时间限定
biz_id	String	业务ID，ID字符串。
biz_info	String	业务对象信息。
status	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
biz_version	Integer	业务版本，只读。
create_time	String	创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
update_time	String	更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。

**表28** TableMappingVO
参数	参数类型	描述
id	String	编码，ID字符串。
name	String	名称。
description	String	描述。
target_table_id	String	目的表ID，ID字符串。
src_model_id	String	来源表在关系建模中的模型ID，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	创建时间，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
update_time	String	更新时间，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
create_by	String	创建人。
update_by	String	更新人。

**表29** TableMappingDetailVO
参数	参数类型	描述
id	String	编码，ID字符串。
mapping_id	String	名称。
target_attr_id	String	目的字段ID，ID字符串。
target_attr_name	String	目的字段排序。
src_table_ids	String	源表ID。
src_table_names	Array of strings	源表名称数组，只读。
src_table_db_names	Array of strings	源表db名称数组，只读。
src_table_model_ids	Array of strings	源表在关系建模中的模型ID数组，只读，ID字符串。
src_table_id_list	Array of strings	源表ID数组，只读，ID字符串。
src_attr_ids	String	源表字段ID。
src_attr_names	Array of strings	源表字段名称数组，只读。
src_attr_id_list	Array of strings	源表字段ID数组，只读，ID字符串。
remark	String	备注。
create_time	String	创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
update_time	String	更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
create_by	String	创建人。
update_by	String	更新人。
target_attr	Object	目标属性。

**表30** MappingSourceTableVO
参数	参数类型	描述
table1_id	String	表1ID，ID字符串。
table2_id	String	表2ID，ID字符串。
table1_name	String	表1名称。
table2_name	String	表2名称。
join_type	String	关联类型。枚举值： LEFT: 左外连接 RIGHT: 右外连接 INNER: 内连接 FULL: 全连接
join_fields	Array of MappingJoinFieldVO objects	on条件。

**表31** MappingJoinFieldVO
参数	参数类型	描述
field1_id	String	属性1ID，ID字符串。
field2_id	String	属性2ID，ID字符串。
field1_name	String	属性1名称。
field2_name	String	属性2名称。

**表32** MappingSourceFieldVO
参数	参数类型	描述
target_field_id	String	目标字段ID，当前表的某个字段，ID字符串。
target_field_name	String	目标字段编码。
field_ids	String	来源字段ID，多个ID以逗号分隔。
transform_expression	String	转换表达式。
field_names	Array of strings	来源字段名称列表。
changed	Boolean	字段是否发生变化。

**表33** BizDatasourceRelationVO
参数	参数类型	描述
id	String	编码，ID字符串。
biz_id	String	业务对象信息，ID字符串。
biz_type	String	业务对象类型。
dw_type	String	数据连接类型，对应表所在的数仓类型，取值可以为DWS、MRS_HIVE、POSTGRESQL、MRS_SPARK、CLICKHOUSE、MYSQL、ORACLE和DORIS等。
dw_id	String	数据连接ID。
dw_name	String	数据连接名，只读。
db_name	String	数据库名。
queue_name	String	dli数据连接执行sql所需的队列，数据连接类型为DLI时必须。
schema	String	DWS类型需要。

**表34** SelfDefinedFieldVO
参数	参数类型	描述
fd_name_ch	String	自定义项中文名。
fd_name_en	String	自定义项英文名。
not_null	Boolean	是否必填。
fd_value	String	属性值。

**表35** WorkspaceVO
参数	参数类型	描述
id	String	编号，ID字符串。
name	String	工作区名字。
description	String	描述。
is_physical	Boolean	是否为物理表。
frequent	Boolean	是否为常用。
top	Boolean	分层治理。
level	String	数据治理分层。枚举值： SDI: 贴源数据层 DWI: 数据整合层 DWR: 数据报告层 DM: 数据集市层
dw_type	String	数据连接类型，对应表所在的数仓类型，取值可以为DWS、MRS_HIVE、POSTGRESQL、MRS_SPARK、CLICKHOUSE、MYSQL、ORACLE和DORIS等。
create_time	String	创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
update_time	String	更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
create_by	String	创建人。
update_by	String	更新人。
type	String	工作区类型枚举。枚举值： THIRD_NF: 关系建模 DIMENSION: 维度建模
biz_catalog_ids	String	关联的业务分层的ID列表 {"l1Ids":[],"l2Ids":[],"l3Ids":[]}。
databases	Array of strings	数据库名称数组。
table_model_prefix	String	模型校验前缀，长度不超过100，数字字母下划线组成，字母开头

状态码： 400

**表36** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，如DS.6000，请求处理失败。
error_msg	String	错误信息。
data	Object	返回的数据信息。

状态码： 401

**表37** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，如DS.6000，请求处理失败。
error_msg	String	错误信息。
data	Object	返回的数据信息。

状态码： 403

**表38** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，如DS.6000，请求处理失败。
error_msg	String	错误信息。
data	Object	返回的数据信息。

请求示例

根据下列参数，更新维度。

PUT https://{endpoint}/v2/{project_id}/design/dimensions

{
  "id" : "1300473264673533952",
  "model_id" : "1255482244563357696",
  "name_ch" : "测试维度",
  "name_en" : "dim_test_dimension",
  "alias" : "",
  "owner" : "test_user",
  "dimension_type" : "COMMON",
  "description" : "无",
  "l3_id" : "1169309252771299328",
  "attributes" : [ {
    "id" : "1300473264694505472",
    "name_ch" : "测试维度_代理键",
    "name_en" : "dim_key",
    "alias" : "",
    "description" : "",
    "data_type" : "BIGINT",
    "data_type_extend" : null,
    "is_biz_primary" : false,
    "is_primary_key" : true,
    "is_partition_key" : false,
    "not_null" : false,
    "ordinal" : 1,
    "dimension_id" : "1300473264673533952",
    "create_by" : "string",
    "stand_row_id" : null,
    "stand_row_name" : null,
    "secrecy_levels" : null,
    "self_defined_fields" : [ ]
  }, {
    "id" : "1300473264694505473",
    "name_ch" : "测试维度_属性",
    "name_en" : "test_field",
    "alias" : "",
    "description" : "",
    "data_type" : "BIGINT",
    "data_type_extend" : null,
    "is_biz_primary" : false,
    "is_primary_key" : false,
    "is_partition_key" : false,
    "not_null" : false,
    "ordinal" : 2,
    "dimension_id" : "1300473264673533952",
    "create_by" : "string",
    "stand_row_id" : null,
    "stand_row_name" : null,
    "secrecy_levels" : null,
    "self_defined_fields" : [ ]
  } ],
  "datasource" : {
    "id" : 0,
    "biz_type" : "DIMENSION",
    "dw_type" : "DWS",
    "dw_id" : "8259af52bd294f98920ebce75a426391",
    "db_name" : "bi",
    "schema" : ""
  },
  "obs_location" : "",
  "self_defined_fields" : null,
  "configs" : "{}",
  "table_type" : "MANAGED",
  "mappings" : [ ]
}

响应示例

状态码： 400

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user request is illegal."
}

状态码： 401

{
  "error_code" : "DS.60xx",
  "error_msg" : "User authentication failed."
}

状态码： 403

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user does not have permission to call this API."
}

状态码

状态码	描述
200	Success，返回data数据是 DimensionVO。
400	BadRequest
401	Unauthorized
403	Forbidden

父主题：维度接口

上一篇：新建维度

下一篇：删除维度

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消