华为云用户手册

URI GET /v2/{project_id}/design/subjects 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 按名称或编码模糊查询 create_by 否 String 按创建者查询 owner 否 String 按负责人查询 status 否 String 业务状态 枚举值： DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT 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 parent_id 否 Long 父目录ID，根节点没有此ID，空值为所有，-1为根节点下节点

响应示例 状态码： 200 Success，返回data数据是MetricRelationVOList { "data" : { "value" : { "all" : [ { "vo" : { "id" : "1014197025488699392", "name_en" : "zonghe8830", "name_ch" : "zonghe8830(testweidu830)", "description" : "", "create_by" : "abc", "data_type" : "STRING", "l1_id" : null, "l2_id" : null, "l3_id" : "767858832738234368", "status" : "DRAFT", "atomic_index_id" : "1014195214723756032", "time_condition_id" : null, "time_field_id" : null, "time_field_name" : null, "common_conditions" : [ ], "dimension_groups" : [ { "group_id" : "1014194851576721408", "role" : null, "dimension_id" : "1014194851576721408", "hierarchies_id" : null, "ordinal" : 1, "group_name" : "testweidu830", "group_code" : "testweidu830", "biz_type" : "DIMENSION", "hierarchies" : null, "l1" : null, "l2" : null, "l3" : null, "l1_id" : null, "l2_id" : null, "l3_id" : null, "dw_type" : null, "id" : "1014197025585168384" } ], "monitor" : null, "atomic_index" : { "id" : "1014195214723756032", "name_en" : "zonghe8830", "name_ch" : "zonghe8830", "description" : "", "create_by" : null, "cal_exp" : "sum(${1014195020200325120}) ", "cal_fn_ids" : null, "l1_id" : null, "l2_id" : null, "l3_id" : null, "table_id" : "1014195020183547904", "tb_name" : null, "dw_type" : null, "field_ids" : [ "1014195020200325120" ], "field_names" : null, "status" : "DRAFT", "biz_type" : "FACT_LOGIC_TABLE", "create_time" : "2022-09-02T09:56:31.536+08:00", "update_time" : "2022-09-02T09:56:31.536+08:00", "l1" : null, "l2" : null, "l3" : null, "approval_info" : null, "new_biz" : null }, "time_condition_name" : null, "create_time" : "2022-08-30T15:36:54+08:00", "update_time" : "2022-08-30T15:36:54+08:00", "l1" : null, "l2" : null, "l3" : null, "summary_table_id" : null, "approval_info" : null, "new_biz" : null }, "id" : "1014197025488699392", "tables" : [ ], "biz_type" : "DERIVATIVE_INDEX", "parent_ids" : [ ], "child_ids" : [ "1014195214723756032" ] } ], "total" : 2, "groups" : { "1014194851576721408" : { "dimension_groups" : [ { "group_id" : "1014194851576721408", "role" : null, "dimension_id" : "1014194851576721408", "hierarchies_id" : null, "ordinal" : 1, "group_name" : "testweidu830", "group_code" : "testweidu830", "biz_type" : "DIMENSION", "hierarchies" : null, "l1" : null, "l2" : null, "l3" : null, "l1_id" : null, "l2_id" : null, "l3_id" : null, "dw_type" : null, "id" : "1014197025585168384" } ], "ids" : [ "1014197025488699392" ] } }, "links" : { "vo" : { "id" : "1014197025488699392", "name_en" : "zonghe8830", "name_ch" : "zonghe8830(testweidu830)", "description" : "", "create_by" : "abc", "data_type" : "STRING", "l1_id" : null, "l2_id" : null, "l3_id" : "767858832738234368", "status" : "DRAFT", "atomic_index_id" : "1014195214723756032", "time_condition_id" : null, "time_field_id" : null, "time_field_name" : null, "common_conditions" : [ ], "dimension_groups" : [ { "group_id" : "1014194851576721408", "role" : null, "dimension_id" : "1014194851576721408", "hierarchies_id" : null, "ordinal" : 1, "group_name" : "testweidu830", "group_code" : "testweidu830", "biz_type" : "DIMENSION", "hierarchies" : null, "l1" : null, "l2" : null, "l3" : null, "l1_id" : null, "l2_id" : null, "l3_id" : null, "dw_type" : null, "id" : "1014197025585168384" } ], "monitor" : null, "atomic_index" : { "id" : "1014195214723756032", "name_en" : "zonghe8830", "name_ch" : "zonghe8830", "description" : "", "create_by" : null, "cal_exp" : "sum(${1014195020200325120}) ", "cal_fn_ids" : null, "l1_id" : null, "l2_id" : null, "l3_id" : null, "table_id" : "1014195020183547904", "tb_name" : null, "dw_type" : null, "field_ids" : [ "1014195020200325120" ], "field_names" : null, "status" : "DRAFT", "biz_type" : "FACT_LOGIC_TABLE", "create_time" : "2022-09-02T09:56:31.536+08:00", "update_time" : "2022-09-02T09:56:31.536+08:00", "l1" : null, "l2" : null, "l3" : null, "approval_info" : null, "new_biz" : null }, "time_condition_name" : null, "create_time" : "2022-08-30T15:36:54+08:00", "update_time" : "2022-08-30T15:36:54+08:00", "l1" : null, "l2" : null, "l3" : null, "summary_table_id" : null, "approval_info" : null, "new_biz" : null }, "id" : "1014197025488699392", "tables" : [ ], "biz_type" : "DERIVATIVE_INDEX", "parent_ids" : [ ], "child_ids" : [ "1014195214723756032" ] } } } }

响应参数 状态码： 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 返回的数据信息

请求示例 创建一个作业名称为myJob的作业，作业类型为BATCH，作业调度配置为CRON，作业在目录树上的路径为/myDir，作业运行日志存放的OBS路径为obs://dlf-test-log。 POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs { "basicConfig": { "customFields": {}, "executeUser": "", "instanceTimeout": 0, "owner": "test_user", "priority": 0 }, "directory": "/myDir", "logPath": "obs://dlf-test-log", "name": "myJob", "nodes": [ { "failPolicy": "FAIL_CHILD", "location": { "x": "-45.5", "y": "-134.5" }, "maxExecutionTime": 360, "name": "MRS_Hive_SQL", "pollingInterval": 20, "preNodeName": [], "properties": [ { "name": "scriptName", "value": "test_hive_sql" }, { "name": "connectionName", "value": "mrs_hive_test" }, { "name": "database", "value": "default" }, { "name": "scriptArgs", "value": "test_var=111" } ], "retryInterval": 120, "retryTimes": 0, "type": "HiveSQL" } ], "processType": "BATCH", "schedule": { "type": "CRON" } }

响应示例 状态码： 200 Success，返回数据是BizCatalogVO { "data" : { "value" : [ { "name" : "db", "description" : "db", "id" : "db", "parent_id" : "db", "prev_id" : "db", "tenant_id" : "tid", "create_time" : 1111, "update_time" : 2222, "create_by" : "test", "update_by" : "test" } ] } }

响应参数 状态码： 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 返回的数据信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 流程名称 最大长度：600 description 否 String 描述 最大长度：2000 guid 否 String 对应资产中id owner 是 String 责任人 最大长度：4000 parent_id 否 Long 父目录id，没有则为根目录 prev_id 否 Long 上个节点ID,没有则为首节点 next_id 否 Long 下个节点ID,没有则为尾节点 id 是 Long 创建时传空，更新时必填 qualified_id 否 String 认证ID，自动生成 create_by 否 String 创建人 update_by 否 String 更新人 create_time 否 String 创建时间 update_time 否 String 更新时间 bizmetric_num 否 Integer 拥有业务指标数量，前端不传 children_num 否 Integer 拥有子流程的数量，不包括子流程的子流程 children 否 Array of BizCatalogVO objects 下层子目录

URI GET /v2/{project_id}/design/directorys 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询条数，即查询Y条数据。默认值50，取值范围[1,100] 最大值：100 缺省值：50 offset 否 Integer 查询起始坐标，即跳过X条数据，仅支持0或limit的整数倍，不满足则向下取整。默认值0 缺省值：0 type 是 String 获取该目录下的数据，如果有子目录，获取所有子目录的数据 枚举值： CODE STANDARD_ELEMENT

响应参数 状态码： 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数据是带有子目录的目录 { "data" : { "value" : [ { "name" : "db", "description" : "db", "type" : "db", "id" : "db", "parent_id" : "db", "prev_id" : "db", "root_id" : "db", "qualified_name" : "qname", "tenant_id" : "tid", "create_time" : 1111, "update_time" : 2222, "create_by" : "test", "update_by" : "test", "children" : [ { "name" : "child", "description" : "db", "xxxx" : "其他属性", "children" : [ { "name" : "child_of_child", "xxxx" : "其他属性" } ] } ] } ] } }

响应示例 状态码： 200 Success，返回data数据是 BizMetricVO 详情 { "data" : { "value" : { "id" : "902866491765080064", "name" : "总车费", "code" : "ZB000001", "name_alias" : "", "biz_type" : null, "status" : "PUBLISHED", "biz_catalog_id" : "887366192090767360", "biz_catalog_path" : null, "create_by" : "abc", "update_by" : "abc", "data_origin" : "", "unit" : "", "time_filters" : "天", "dimensions" : "test", "general_filters" : "", "interval_type" : "REAL_TIME", "apply_scenario" : "", "technical_metric" : "873265992019640320", "technical_metric_name" : "总车费1(供应商)", "technical_metric_type" : "DERIVATIVE_INDEX", "measure" : "", "owner" : "abc", "owner_department" : "数据管理部", "destination" : "统计出租车公司收入", "guid" : "2c993087-2aff-43f7-9252-178ce52e7e7c", "definition" : "出租车公司收入", "expression" : "sum ( 总车费 )", "remark" : "", "approval_info" : { "id" : "933768706708971520", "tenant_id" : null, "name_ch" : null, "name_en" : null, "biz_id" : "902866491765080064", "biz_type" : null, "biz_info" : null, "biz_info_obj" : null, "biz_version" : 0, "biz_status" : "PUBLISHED", "approval_status" : "APPROVED", "approval_type" : null, "submit_time" : "2022-01-20T17:03:28+08:00", "create_by" : null, "l1" : null, "l2" : null, "l3" : null, "approval_time" : "2022-01-20T17:03:28+08:00", "approver" : "abc", "email" : null, "msg" : "Fast Approval OK.", "directory_path" : null }, "new_biz" : null, "create_time" : "2021-10-27T10:29:06+08:00", "update_time" : "2022-01-20T17:03:28+08:00", "l1" : "L1", "l2" : null, "l3" : null, "biz_metric" : "UPDATE_SUCCESS", "summary_status" : "SUMMARY_SUCCESS" } } }

响应参数 状态码： 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 表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数据是 DimensionVO 详情 { "data" : { "value" : { "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" : "873232498044411904", "l2_id" : "873232798230675456", "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" : { "id" : "873258129008336896", "tenant_id" : null, "name_ch" : null, "name_en" : null, "biz_id" : "873251051724242944", "biz_type" : null, "biz_info" : null, "biz_info_obj" : null, "biz_version" : 0, "biz_status" : "PUBLISHED", "approval_status" : "APPROVED", "approval_type" : null, "submit_time" : "2021-08-06T17:36:02+08:00", "create_by" : null, "l1" : null, "l2" : null, "l3" : null, "approval_time" : "2021-08-06T17:36:03+08:00", "approver" : "abc", "email" : null, "msg" : "Fast Approval OK.", "directory_path" : null }, "new_biz" : null, "l1" : "城市交通", "l2" : "集团", "l3" : "供应商", "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 } } }

请求示例 { "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 表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

响应参数 状态码： 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 返回的数据信息

请求示例 { "id" : "953670725619867648", "name" : "test", "description" : "this is an example.", "is_physical" : false, "frequent" : false, "top" : true, "level" : null, "dw_type" : "UNSPECIFIED", "create_time" : "2022-03-16T15:06:59.333+08:00", "update_time" : "2022-03-16T15:06:59.333+08:00", "create_by" : "ei_dgc", "update_by" : "ei_dgc", "type" : "THIRD_NF", "biz_catalog_ids" : null, "databases" : null }

响应示例 状态码： 200 Success，返回data数据是 WorkspaceVO { "data" : { "value" : { "id" : "1014218815216717824", "name" : "test", "description" : "abc123", "is_physical" : true, "frequent" : false, "top" : true, "level" : "SDI", "dw_type" : "DLI", "create_time" : "2022-08-30T17:03:29+08:00", "update_time" : "2022-08-30T17:05:08.773+08:00", "create_by" : "abc", "update_by" : "abc", "type" : "THIRD_NF", "biz_catalog_ids" : null, "databases" : null } } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 id 否 Long 编号 name 是 String 工作区名字 最大长度：250 description 否 String 最大长度：600 is_physical 否 Boolean 是否为物理表 缺省值：true frequent 否 Boolean 是否为常用 缺省值：true top 否 Boolean 分层治理 缺省值：true level 否 String 数据治理分层 枚举值： SDI DWI DWR DM dw_type 否 String 数据连接类型 create_time 否 String 创建时间 update_time 否 String 更新时间 create_by 否 String 创建人 update_by 否 String 更新人 type 是 String 工作区类型枚举 枚举值： THIRD_NF DIMENSION biz_catalog_ids 否 String 关联的业务分层的id列表 {"l1Ids":[],"l2Ids":[],"l3Ids":[]} databases 否 Array of strings 数据库名称数组

请求示例 { "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" : "1014131824240230400", "name_en" : "test", "name_ch" : "test", "tb_version" : 0, "directory_id" : "1012307270173851648", "directory_path" : null, "description" : "", "create_by" : "abc", "status" : "DRAFT", "create_time" : "2022-08-30T11:17:48.557+08:00", "update_time" : "2022-08-30T11:17:48.557+08:00", "approval_info" : null, "new_biz" : null, "code_table_fields" : [ { "id" : null, "code_table_id" : null, "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" : null, "code_table_id" : null, "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 } ] } } }

响应参数 状态码： 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 返回的数据信息

请求参数 表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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 type 是 String 自定义项类型:TABLE, ATTRIBUTE, SUBJECT, METRIC 枚举值： TABLE ATTRIBUTE SUBJECT METRIC fields 否 Array of CustomizedFieldsVO objects 自定义项列表 表4 CustomizedFieldsVO 参数 是否必选 参数类型 描述 id 否 Long 编码 name_ch 是 String 中文名称 最大长度：100 name_en 是 String 英文名称 最大长度：100 not_null 是 Boolean 是否必填 optional_values 否 String 可选值。分号分隔 type 是 String 自定义项类型：TABLE, ATTRIBUTE, SUBJECT, METRIC 枚举值： TABLE ATTRIBUTE SUBJECT METRIC ordinal 否 Integer 顺序 description 否 String 描述 最大长度：200 create_by 否 String 创建人 update_by 否 String 更新人 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 返回的数据信息

响应示例 状态码： 200 Success { "data" : { "value" : { "id" : "1042120264055414784", "name_ch" : "test", "name_en" : "test", "not_null" : true, "optional_values" : "abc", "type" : "ATTRIBUTE", "ordinal" : 0, "description" : "desc", "create_by" : "tester", "update_by" : "tester", "create_time" : "2022-08-30T17:03:29+08:00", "update_time" : "2022-08-30T17:03:29+08:00" } } }

请求示例 { "type" : "TABLE", "fields" : [ { "id" : "1033443457986891776", "name_ch" : "自定义", "name_en" : "zdy", "not_null" : true, "optional_values" : "aaa;bbb", "type" : "TABLE", "ordinal" : 0, "description" : "自定义项", "create_by" : "tester", "update_by" : "tester", "create_time" : "2022-08-30T17:03:29+08:00", "update_time" : "2022-08-30T17:03:29+08:00" } ] }