华为云用户手册

  • 请求示例 { "id" : 0, "directory_id" : "793889791589650432", "values" : [ { "fd_name" : "nameEn", "fd_value" : "demo" }, { "fd_name" : "dataType", "fd_value" : "STRING" }, { "fd_name" : "dataLength", "fd_value" : "128" }, { "fd_name" : "hasAllowValueList", "fd_value" : false }, { "fd_name" : "allowList", "fd_value" : "" }, { "fd_name" : "referCodeTable", "fd_value" : "885123958788317184" }, { "fd_name" : "codeStandColumn", "fd_value" : "52470" }, { "fd_name" : "dqcRule", "fd_value" : "" }, { "fd_name" : "ruleOwner", "fd_value" : "liuxu" }, { "fd_name" : "dataMonitorOwner", "fd_value" : "liuxu" }, { "fd_name" : "standardLevel", "fd_value" : "domain" }, { "fd_name" : "description", "fd_value" : "这是一个demo" } ] }
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 values 是 Array of StandElementValueVO objects 属性信息 id 否 Long ID directory_id 是 Long 标准所属目录 directory_path 否 String 目录树 row_id 否 Long 标准行的id status 否 String 业务状态 枚举值: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT approval_info 否 ApprovalVO object 审批信息 new_biz 否 BizVersionManageVO object 业务版本管理. create_by 否 String 创建人 update_by 否 String 更新人 create_time 否 String 创建时间 update_time 否 String 更新时间 表4 StandElementValueVO 参数 是否必选 参数类型 描述 fd_name 是 String 属性名称 fd_value 否 String 属性值 fd_id 否 Long 属性定义的id directory_id 否 Long 标准所属目录 row_id 否 Long 标准所属行 id 否 Long ID status 否 String 业务状态 枚举值: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT create_by 否 String 创建人 update_by 否 String 更新人 create_time 否 String 创建时间 update_time 否 String 更新时间 表5 ApprovalVO 参数 是否必选 参数类型 描述 id 否 Long ID tenant_id 否 String tenant id name_ch 否 String 业务中文名 name_en 否 String 业务英文名 biz_id 否 Long 业务ID biz_type 否 String 业务类型 枚举值: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT biz_info 否 String 业务详情 biz_info_obj 否 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 BizVersionManageVO 参数 是否必选 参数类型 描述 id 否 Long ID信息 biz_type 否 String 业务类型 枚举值: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT biz_id 否 Long 业务id biz_info 否 String 业务对象信息 status 否 String 业务状态 枚举值: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT biz_version 否 Integer 业务版本 create_time 否 String 创建时间 update_time 否 String 更新时间
  • 响应示例 状态码: 200 Success,返回data数据是所有l1、l2、l3实体 { "data" : { "value" : [ { "name_ch" : "城市交通", "name_en" : "city_traffic", "description" : "", "qualified_name" : "city_traffic@Business.xxx", "guid" : "f6e674d6-f657-4734-b417-837536c12eee", "code" : null, "alias" : "", "status" : "DRAFT", "new_biz" : null, "data_owner" : "", "data_owner_list" : "[\"abc\"]", "data_department" : null, "path" : "城市交通", "level" : 1, "ordinal" : 1, "owner" : "abc", "parent_id" : null, "swap_order_id" : null, "id" : "873232498044411904", "qualified_id" : null, "create_by" : "abc", "update_by" : "abc", "create_time" : "2021-08-06T15:54:11+08:00", "update_time" : "2022-08-30T10:59:38+08:00", "self_defined_fields" : [ { "fd_name_ch" : "备注", "fd_name_en" : "ez", "not_null" : false, "fd_value" : "" } ], "children_num" : null, "children" : null } ] } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • URI GET /v2/{project_id}/design/subjects/business 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询条数,即查询Y条数据。默认值50,取值范围[1,100] 最大值:100 缺省值:50 offset 否 Integer 查询起始坐标,即跳过X条数据,仅支持0或limit的整数倍,不满足则向下取整。默认值0 缺省值:0
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • 响应示例 状态码: 200 Success,返回数据标准详情 { "data" : { "value" : { "id" : 0, "directory_id" : "793889791589650432", "values" : [ { "fd_name" : "nameEn", "fd_value" : "demo" }, { "fd_name" : "dataType", "fd_value" : "STRING" }, { "fd_name" : "dataLength", "fd_value" : "128" }, { "fd_name" : "hasAllowValueList", "fd_value" : false }, { "fd_name" : "allowList", "fd_value" : "" }, { "fd_name" : "referCodeTable", "fd_value" : "885123958788317184" }, { "fd_name" : "codeStandColumn", "fd_value" : "52470" }, { "fd_name" : "dqcRule", "fd_value" : "{}" }, { "fd_name" : "ruleOwner", "fd_value" : "liuxu" }, { "fd_name" : "dataMonitorOwner", "fd_value" : "liuxu" }, { "fd_name" : "standardLevel", "fd_value" : "domain" }, { "fd_name" : "description", "fd_value" : "这是一个demo" } ] } } }
  • 响应示例 状态码: 200 Success,返回data数据是 RelationVO 数组, 以及总数 { "data" : { "value" : { "records" : [ { "id" : "1000068927784710144", "source_table_id" : "873243083737899008", "target_table_id" : "888462883313393664", "name" : "sdi_taxi_trip_data_wang_1", "source_table_name" : "demo_sdi_db.sdi_taxi_trip_data", "target_table_name" : "default.wang", "role" : null, "tenant_id" : "xxx", "source_type" : "ONE_OR_N", "target_type" : "ONE_OR_N", "create_by" : "abc", "update_by" : "abc", "create_time" : "2022-07-22T15:56:53+08:00", "update_time" : "2022-07-22T15:57:28+08:00", "mappings" : [ { "id" : "1000068927818264576", "relation_id" : "1000068927784710144", "source_field_id" : "873243083737899013", "target_field_id" : "888462883317587968", "source_field_name" : "trip_distance", "target_field_name" : "id", "create_by" : "abc", "update_by" : "abc", "create_time" : "2022-07-22T15:56:53+08:00", "update_time" : "2022-07-22T15:57:28+08:00" } ] } ] } } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • URI GET /v2/{project_id}/design/relation 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 按名称或编码模糊查询 create_by 否 String 按创建者查询 begin_time 否 String 时间过滤左边界,与end_time一起使用,只支持时间范围过滤,单边过滤无效 end_time 否 String 时间过滤右边界,与begin_time一起使用只支持时间范围过滤,单边过滤无效 limit 否 Integer 查询条数,即查询Y条数据。默认值50,取值范围[1,100] 最大值:100 缺省值:50 offset 否 Integer 查询起始坐标,即跳过X条数据,仅支持0或limit的整数倍,不满足则向下取整。默认值0 缺省值:0
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • 响应示例 状态码: 200 Success,返回data数据是 FactLogicTableVO 详情 { "data" : { "value" : { "id" : "1014288257548156928", "tb_name" : "fact_order", "tb_logic_name" : "订单", "l1_id" : "873232498044411904", "l2_id" : null, "l3_id" : null, "description" : "无", "dw_name" : "dli_link_1", "owner" : "test02", "create_by" : "abc", "queue_name" : "default", "dw_id" : "2c9080f07b03db8d017b198a4a20002f", "db_name" : "ctz_test", "tb_id" : null, "dim_table_ids" : null, "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "schema" : "", "distribute" : null, "distribute_column" : null, "table_type" : "MANAGED", "status" : "DRAFT", "tb_guid" : null, "tb_logic_guid" : null, "dw_type" : "DLI", "l1" : "城市交通", "l2" : null, "l3" : null, "create_time" : "2022-08-30T21:39:25+08:00", "update_time" : "2022-08-30T21:39:25+08:00", "approval_info" : null, "new_biz" : null, "dimensions" : [ { "id" : "1014288257556545536", "fact_logic_table_id" : "1014288257548156928", "ordinal" : 1, "dimension_id" : "873251051724242944", "role" : null, "dimension" : { "id" : "873251051724242944", "name_en" : "dim_vendor", "dimension_type" : "LOOKUP", "name_ch" : "供应商", "description" : "无", "create_by" : "abc", "update_by" : null, "code_table_id" : "873235088123527168", "code_table" : null, "l1_id" : null, "l2_id" : null, "l3_id" : "873233599258927104", "hierarchies" : [ ], "status" : "PUBLISHED", "create_time" : "2021-08-06T17:07:55+08:00", "update_time" : "2021-08-06T17:36:03+08:00", "approval_info" : null, "new_biz" : null, "l1" : null, "l2" : null, "l3" : null, "attributes" : [ { "id" : "873251051732631552", "dimension_id" : "873251051724242944", "code_table_field_id" : null, "name_en" : "vendor_id", "name_ch" : "供应商id", "description" : "", "create_by" : "abc", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : null, "is_primary_key" : true, "is_biz_primary" : true, "is_partition_key" : false, "ordinal" : 1, "not_null" : true, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "status" : null, "create_time" : "2021-08-06T17:07:55+08:00", "update_time" : "2021-10-14T10:54:54+08:00", "alias" : null, "self_defined_fields" : null }, { "id" : "873251051732631553", "dimension_id" : "873251051724242944", "code_table_field_id" : null, "name_en" : "vendor_value", "name_ch" : "供应商", "description" : "", "create_by" : "abc", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : null, "is_primary_key" : false, "is_biz_primary" : false, "is_partition_key" : false, "ordinal" : 2, "not_null" : false, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "status" : null, "create_time" : "2021-08-06T17:07:55+08:00", "update_time" : "2021-10-14T10:54:54+08:00", "alias" : null, "self_defined_fields" : null } ], "mappings" : null, "datasource" : { "id" : "873251051745214464", "biz_id" : "873251051724242944", "biz_type" : "DIMENSION", "dw_type" : "DLI", "dw_id" : "2c9080f07b03db8d017b198a4a20002f", "dw_name" : null, "db_name" : "demo_dwr_db", "queue_name" : "dgc_dli_test", "schema" : "" }, "owner" : "abc", "table_type" : "MANAGED", "distribute" : null, "distribute_column" : null, "alias" : "", "self_defined_fields" : null }, "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : true, "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : null, "name_en" : "vendor_id", "name_ch" : "供应商id", "not_null" : false, "attribute_type" : "FACT_DIMENSION", "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : [ ], "alias" : "", "self_defined_fields" : [ ] } ], "attributes" : null, "mappings" : [ ], "measures" : [ { "id" : "1014288257556545537", "fact_logic_table_id" : "1014288257548156928", "ordinal" : 2, "dimension_id" : null, "role" : null, "dimension" : null, "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : null, "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : "", "name_en" : "fare", "name_ch" : "费用", "not_null" : false, "attribute_type" : "FACT_MEASURE", "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : [ ], "alias" : "", "self_defined_fields" : [ ] } ], "table_attributes" : [ { "id" : "1014288257556545536", "fact_logic_table_id" : "1014288257548156928", "ordinal" : 1, "dimension_id" : "873251051724242944", "role" : null, "dimension" : { "id" : "873251051724242944", "name_en" : "dim_vendor", "dimension_type" : "LOOKUP", "name_ch" : "供应商", "description" : "无", "create_by" : "abc", "update_by" : null, "code_table_id" : "873235088123527168", "code_table" : null, "l1_id" : null, "l2_id" : null, "l3_id" : "873233599258927104", "hierarchies" : [ ], "status" : "PUBLISHED", "create_time" : "2021-08-06T17:07:55+08:00", "update_time" : "2021-08-06T17:36:03+08:00", "approval_info" : null, "new_biz" : null, "l1" : null, "l2" : null, "l3" : null, "attributes" : [ { "id" : "873251051732631552", "dimension_id" : "873251051724242944", "code_table_field_id" : null, "name_en" : "vendor_id", "name_ch" : "供应商id", "description" : "", "create_by" : "abc", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : null, "is_primary_key" : true, "is_biz_primary" : true, "is_partition_key" : false, "ordinal" : 1, "not_null" : true, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "status" : null, "create_time" : "2021-08-06T17:07:55+08:00", "update_time" : "2021-10-14T10:54:54+08:00", "alias" : null, "self_defined_fields" : null }, { "id" : "873251051732631553", "dimension_id" : "873251051724242944", "code_table_field_id" : null, "name_en" : "vendor_value", "name_ch" : "供应商", "description" : "", "create_by" : "abc", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : null, "is_primary_key" : false, "is_biz_primary" : false, "is_partition_key" : false, "ordinal" : 2, "not_null" : false, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "status" : null, "create_time" : "2021-08-06T17:07:55+08:00", "update_time" : "2021-10-14T10:54:54+08:00", "alias" : null, "self_defined_fields" : null } ], "mappings" : null, "datasource" : { "id" : "873251051745214464", "biz_id" : "873251051724242944", "biz_type" : "DIMENSION", "dw_type" : "DLI", "dw_id" : "2c9080f07b03db8d017b198a4a20002f", "dw_name" : null, "db_name" : "demo_dwr_db", "queue_name" : "dgc_dli_test", "schema" : "" }, "owner" : "abc", "table_type" : "MANAGED", "distribute" : null, "distribute_column" : null, "alias" : "", "self_defined_fields" : null }, "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : true, "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : null, "name_en" : "vendor_id", "name_ch" : "供应商id", "not_null" : false, "attribute_type" : "FACT_DIMENSION", "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : [ ], "alias" : "", "self_defined_fields" : [ ] }, { "id" : "1014288257556545537", "fact_logic_table_id" : "1014288257548156928", "ordinal" : 2, "dimension_id" : null, "role" : null, "dimension" : null, "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : null, "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : "", "name_en" : "fare", "name_ch" : "费用", "not_null" : false, "attribute_type" : "FACT_MEASURE", "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : [ ], "alias" : "", "self_defined_fields" : [ ] } ], "physical_table" : "NO_NEED", "technical_asset" : "NO_NEED", "business_asset" : "NO_NEED", "meta_data_link" : "NO_NEED", "data_quality" : "NO_NEED", "summary_status" : "NO_NEED", "quality_id" : null, "alias" : "", "self_defined_fields" : [ { "fd_name_ch" : "数据管家", "fd_name_en" : "sjgj", "not_null" : false, "fd_value" : "" }, { "fd_name_ch" : "责任部门", "fd_name_en" : "zrbm", "not_null" : false, "fd_value" : "" } ] } } }
  • 响应参数 状态码: 200 表8 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • 请求示例 { "name_en" : "demo", "name_ch" : "demo", "description" : "", "code_table_fields" : [ { "ordinal" : 1, "name_ch" : "编码", "name_en" : "code", "data_type" : "STRING", "description" : "", "code_table_field_values" : [ ] }, { "ordinal" : 2, "name_ch" : "值", "name_en" : "value", "data_type" : "STRING", "description" : "", "code_table_field_values" : [ ] } ], "tb_version" : 0, "directory_id" : "793889572823142400" }
  • 响应示例 状态码: 200 Success,返回data数据是 CodeTableVO { "data" : { "value" : { "id" : "1012307352952635392", "name_en" : "RY_000001", "name_ch" : "性别", "tb_version" : 0, "directory_id" : "1012307270173851648", "directory_path" : null, "description" : "", "create_by" : "abc", "status" : "PUBLISHED", "create_time" : "2022-08-25T10:28:01+08:00", "update_time" : "2022-08-25T10:31:08+08:00", "approval_info" : null, "new_biz" : null, "code_table_fields" : [ { "id" : "66929", "code_table_id" : "1012307352952635392", "ordinal" : 1, "name_en" : "code", "name_ch" : "编码", "description" : "", "data_type" : "STRING", "domain_type" : null, "data_type_extend" : null, "is_unique_key" : false, "code_table_field_values" : [ ], "count_field_values" : null }, { "id" : "66930", "code_table_id" : "1012307352952635392", "ordinal" : 2, "name_en" : "value", "name_ch" : "值", "description" : "", "data_type" : "STRING", "domain_type" : null, "data_type_extend" : null, "is_unique_key" : false, "code_table_field_values" : [ ], "count_field_values" : null } ] } } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 id 否 Long ID name_en 是 String 表名称,英文名 最大长度:200 name_ch 是 String 表名称,中文名 最大长度:200 tb_version 否 Integer 表版本 directory_id 是 Long 目录ID directory_path 否 String 目录树 description 否 String 描述 最大长度:600 create_by 否 String 创建人 status 否 String 业务状态 枚举值: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT create_time 否 String 创建时间 update_time 否 String 更新时间 approval_info 否 ApprovalVO object 审批信息 new_biz 否 BizVersionManageVO object 业务版本管理. code_table_fields 是 Array of CodeTableFieldVO objects 码表属性信息 表4 ApprovalVO 参数 是否必选 参数类型 描述 id 否 Long ID tenant_id 否 String tenant id name_ch 否 String 业务中文名 name_en 否 String 业务英文名 biz_id 否 Long 业务ID biz_type 否 String 业务类型 枚举值: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT biz_info 否 String 业务详情 biz_info_obj 否 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 目录树 表5 BizVersionManageVO 参数 是否必选 参数类型 描述 id 否 Long ID信息 biz_type 否 String 业务类型 枚举值: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT biz_id 否 Long 业务id biz_info 否 String 业务对象信息 status 否 String 业务状态 枚举值: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT biz_version 否 Integer 业务版本 create_time 否 String 创建时间 update_time 否 String 更新时间 表6 CodeTableFieldVO 参数 是否必选 参数类型 描述 id 否 Long ID code_table_id 否 Long 所属码表id ordinal 是 Integer 序号 name_en 是 String 字段名,英文 最大长度:600 name_ch 是 String 字段名,中文 最大长度:200 description 否 String 描述 最大长度:600 data_type 是 String 字段类型 domain_type 否 String 字段类型所属域 枚举值: NUMBER STRING DATETIME BLOB OTHER data_type_extend 否 String 数据类型扩展字段 最大长度:50 is_unique_key 否 Boolean 是否唯一 缺省值:false code_table_field_values 否 Array of CodeTableFieldValueVO objects 码表属性值 count_field_values 否 Integer 码表属性值总数 表7 CodeTableFieldValueVO 参数 是否必选 参数类型 描述 id 否 Long ID fd_id 否 Long 所属码表属性id fd_value 否 String 码表属性值 ordinal 否 Integer 序号 description 否 String 描述 最大长度:600
  • 请求示例 { "code" : "ZB000000", "biz_catalog_id" : "1029701703198519304", "name" : "业务指标实例", "name_alias" : "bizMetricDemo", "destination" : "example", "definition" : "example", "expression" : "a+b+c", "data_origin" : "", "unit" : "", "time_filters" : "天", "dimensions" : "公司", "general_filters" : "example", "interval_type" : "DAY", "apply_scenario" : "", "technical_metric" : "", "measure" : "", "owner_department" : "testDep", "owner" : "tester", "remark" : "example", "id" : "1036590187955851264" }
  • 响应示例 状态码: 200 Success,返回data数据是 BizMetricVO { "data" : { "value" : { "id" : "1036590187955851264", "name" : "业务指标实例", "code" : "ZB000000", "name_alias" : "bizMetricDemo", "biz_type" : null, "status" : "DRAFT", "biz_catalog_id" : "1029701703198519304", "biz_catalog_path" : null, "create_by" : "ei_dlf_l00341563", "update_by" : "ei_dlf_l00341563", "data_origin" : "", "unit" : "", "time_filters" : "天", "dimensions" : "公司", "general_filters" : "example", "interval_type" : "DAY", "apply_scenario" : "", "technical_metric" : null, "technical_metric_name" : null, "technical_metric_type" : null, "measure" : "", "owner" : "tester", "owner_department" : "testDep", "destination" : "example", "guid" : null, "definition" : "example", "expression" : "a+b+c", "remark" : "example", "approval_info" : null, "new_biz" : null, "create_time" : "2022-10-31T10:39:20+08:00", "update_time" : "2022-10-31T10:44:15.586+08:00", "l1" : null, "l2" : null, "l3" : null, "biz_metric" : null, "summary_status" : null } } }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 id 否 Long 编码, 更新时必填,创建是为空 name 是 String 指标名称 最大长度:500 code 否 String 指标编码 name_alias 否 String 指标别名 最大长度:500 biz_type 否 String 业务类型 枚举值: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT status 否 String 业务状态 枚举值: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT biz_catalog_id 是 Long 归属的流程架构的id biz_catalog_path 否 String 归属的流程架构路径 create_by 否 String 创建人 update_by 否 String 更新人 data_origin 否 String 数据来源 最大长度:1000 unit 否 String 计量单位 最大长度:50 time_filters 是 String 统计周期(时间限定) 最大长度:500 dimensions 否 String 统计维度 最大长度:1000 general_filters 否 String 统计口径和修饰词 最大长度:1000 interval_type 是 String 刷新频率 缺省值:DAY 枚举值: MINUTE HOUR DAY WEEK MONTH YEAR REAL_TIME HALF_HOUR QUART DOUBLE_WEEK HALF_YEAR HALF_DAY apply_scenario 否 String 应用场景 最大长度:255 technical_metric 否 Long 关联技术指标 technical_metric_name 否 String 关联技术指标名称 technical_metric_type 否 String 业务类型 枚举值: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT measure 否 String 度量对象 最大长度:255 owner 是 String 指标责任人 最大长度:100 owner_department 是 String 指标管理部门 最大长度:600 destination 是 String 设置目的 最大长度:1000 guid 否 String 资产同步后的guid definition 是 String 指标定义 最大长度:1000 expression 是 String 计算公式 最大长度:1000 remark 否 String 备注 最大长度:600 approval_info 否 ApprovalVO object 审批信息 new_biz 否 BizVersionManageVO object 业务版本管理. create_time 否 String 创建时间 update_time 否 String 更新时间 l1 否 String 主题域分组中文名 l2 否 String 主题域中文名 l3 否 String 业务对象中文名 biz_metric 否 String 业务指标同步状态 枚举值: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE summary_status 否 String 同步统计状态 枚举值: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE 表4 ApprovalVO 参数 是否必选 参数类型 描述 id 否 Long ID tenant_id 否 String tenant id name_ch 否 String 业务中文名 name_en 否 String 业务英文名 biz_id 否 Long 业务ID biz_type 否 String 业务类型 枚举值: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT biz_info 否 String 业务详情 biz_info_obj 否 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 目录树 表5 BizVersionManageVO 参数 是否必选 参数类型 描述 id 否 Long ID信息 biz_type 否 String 业务类型 枚举值: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT biz_id 否 Long 业务id biz_info 否 String 业务对象信息 status 否 String 业务状态 枚举值: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT biz_version 否 Integer 业务版本 create_time 否 String 创建时间 update_time 否 String 更新时间
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 biz_infos 是 Array of BizInfoVO objects 业务信息列表. approver_user_id 是 String 审批人user id approver_user_name 是 String 审批人user name email 否 String 审批人邮箱 fast_approval 否 Boolean 快速审批, 非正式场景,用于快速上手体验,仅在当前用户有审批权限时提供 缺省值:false schedule_time 否 String 作业调度时间 表4 BizInfoVO 参数 是否必选 参数类型 描述 biz_id 是 Long 业务ID biz_type 是 String 业务类型 枚举值: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT
  • 请求示例 { "approver_user_id" : "7b71e498e75d44048c9a22dd3c54f978", "approver_user_name" : "ei_dlg", "biz_infos" : [ { "biz_id" : "885123875376193536", "biz_type" : "CODE_TABLE" }, { "biz_id" : "885123958788317184", "biz_type" : "CODE_TABLE" } ], "email" : null, "fast_approval" : true }
  • 响应示例 状态码: 200 Success,返回data数据是 BatchOperationVO对象,批量对象在BatchOperationVO.group属性中 { "data" : { "value" : { "SUCCESS" : [ "name1-id", "name2-id" ], "errors" : "[{id: 111, reason: exceptions}]" } } }
  • 响应示例 状态码: 200 Success,返回data数据是 entity 详情 { "data" : { "value" : { "name_ch" : "示例", "name_en" : "example", "description" : "desc", "qualified_name" : "L3.example@Business.xxx", "guid" : null, "code" : null, "status" : "DRAFT", "new_biz" : null, "alias" : "example", "data_owner" : "example", "data_owner_list" : "[\"abc\"]", "data_department" : null, "path" : "主题3New/示例", "level" : 2, "ordinal" : 2, "owner" : "ei_dlf_l00341563", "parent_id" : "1024715832535695360", "swap_order_id" : null, "id" : "1035859890809266176", "qualified_id" : null, "create_by" : "abc", "update_by" : "abc", "create_time" : "2022-10-29T10:17:23.315+08:00", "update_time" : "2022-10-29T10:17:23.315+08:00", "self_defined_fields" : [ { "fd_name_ch" : "zdy", "fd_name_en" : "zdy", "not_null" : false, "fd_value" : "sdf" } ], "children_num" : null, "children" : null } } }
  • 请求示例 { "id" : "1024715832535691111", "name_ch" : "示例", "name_en" : "example", "description" : "desc", "alias" : "example", "data_owner" : "example", "data_owner_list" : "[\"abc\"]", "parent_id" : "1024715832535695360", "level" : 2, "self_defined_fields" : [ { "fd_name_ch" : "zdy", "fd_name_en" : "zdy", "not_null" : false, "fd_value" : "sdf" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 id 否 Long 编码。更新时必填,创建时可以为空 name_ch 是 String 中文名称 最大长度:200 name_en 是 String 英文名称 最大长度:100 description 否 String 描述信息, 业务对象必填 最大长度:200 alias 否 String 别名 最大长度:200 data_owner 否 String 数据owner部门 最大长度:200 data_owner_list 是 String 数据owner人员 level 是 Integer 层级 parent_id 否 Long 上层主题id,首层则为空 self_defined_fields 否 Array of SelfDefinedFieldVO objects 属性自定义项 表4 SelfDefinedFieldVO 参数 是否必选 参数类型 描述 fd_name_ch 否 String 自定义项中文名 最大长度:200 fd_name_en 否 String 自定义项英文名 最大长度:200 not_null 否 Boolean 是否必填 fd_value 否 String 属性值
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
共100000条