更新业务指标
功能介绍
更新业务指标。
调用方法
请参见如何调用API。
URI
PUT /v2/{project_id}/design/biz-metrics
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
IAM Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 使用Token认证时必选。 |
workspace |
是 |
String |
工作空间ID,获取方法请参见实例ID和工作空间ID。 |
X-Project-Id |
否 |
String |
项目ID,获取方法请参见项目ID和账号ID。 多project场景采用AK/SK认证的接口请求,则该字段必选。 |
Content-Type |
否 |
String |
默认值:application/json;charset=UTF-8 可选,有Body体的情况下必选,没有Body体则无需填写和校验。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
编码,更新时必填,创建时为空,填写String类型替代Long类型。 |
name |
是 |
String |
指标名称。 |
code |
否 |
String |
指标编码,只读。 |
name_alias |
否 |
String |
指标别名。 |
biz_type |
否 |
String |
业务实体类型。 枚举值:
|
status |
否 |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
biz_catalog_id |
是 |
String |
归属的流程架构的ID,填写String类型替代Long类型。 |
biz_catalog_path |
否 |
String |
归属的流程架构路径,只读。 |
create_by |
否 |
String |
创建人,只读。 |
update_by |
否 |
String |
更新人,只读。 |
data_origin |
否 |
String |
数据来源。 |
unit |
否 |
String |
计量单位。 |
time_filters |
是 |
String |
统计周期(时间限定)。 |
dimensions |
否 |
String |
统计维度。 |
general_filters |
否 |
String |
统计口径和修饰词。 |
interval_type |
是 |
String |
刷新频率。 枚举值:
|
apply_scenario |
否 |
String |
应用场景。 |
technical_metric |
否 |
String |
关联技术指标,填写String类型替代Long类型。 |
technical_metric_name |
否 |
String |
关联技术指标名称,只读。 |
technical_metric_type |
否 |
String |
业务实体类型。 枚举值:
|
measure |
否 |
String |
度量对象。 |
owner |
是 |
String |
指标责任人。 |
owner_department |
是 |
String |
指标管理部门。 |
destination |
是 |
String |
设置目的。 |
guid |
否 |
String |
资产同步后的guid,只读。 |
definition |
是 |
String |
指标定义。 |
expression |
是 |
String |
计算公式。 |
remark |
否 |
String |
备注。 |
approval_info |
否 |
ApprovalVO object |
审批信息,只读参数。业务对象最近一次的审批信息,包括审批的业务详情、审核人信息、审核时间等。 |
new_biz |
否 |
BizVersionManageVO object |
业务版本管理,只读。 |
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。 |
l1 |
否 |
String |
主题域分组中文名,只读,创建和更新时无需填写。 |
l2 |
否 |
String |
主题域中文名,只读,创建和更新时无需填写。 |
l3 |
否 |
String |
业务对象中文名,只读,创建和更新时无需填写。 |
biz_metric |
否 |
String |
业务指标同步状态,只读。 |
summary_status |
否 |
String |
同步统计状态,只读。 |
self_defined_fields |
否 |
Array of SelfDefinedFieldVO objects |
自定义项 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
审批单ID,填写String类型替代Long类型。 |
tenant_id |
否 |
String |
项目ID,获取方式参考接口路径参数“project_id”。 |
name_ch |
否 |
String |
业务中文名。 |
name_en |
否 |
String |
业务英文名。 |
biz_id |
否 |
String |
业务ID,填写String类型替代Long类型。 |
biz_type |
否 |
String |
业务实体类型。 枚举值:
|
biz_info |
否 |
String |
序列化之后的业务详情,类型是string。 |
biz_info_obj |
否 |
Object |
业务详情,类型是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 |
否 |
String |
ID信息,填写String类型替代Long类型。 |
biz_type |
否 |
String |
业务实体类型。 枚举值:
|
biz_id |
否 |
String |
业务ID,填写String类型替代Long类型。 |
biz_info |
否 |
String |
业务对象信息。 |
status |
否 |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
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。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
data object |
data,统一的返回结果的最外层数据结构。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
编码,更新时必填,创建时为空,填写String类型替代Long类型。 |
name |
String |
指标名称。 |
code |
String |
指标编码,只读。 |
name_alias |
String |
指标别名。 |
biz_type |
String |
业务实体类型。 枚举值:
|
status |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
biz_catalog_id |
String |
归属的流程架构的ID,填写String类型替代Long类型。 |
biz_catalog_path |
String |
归属的流程架构路径,只读。 |
create_by |
String |
创建人,只读。 |
update_by |
String |
更新人,只读。 |
data_origin |
String |
数据来源。 |
unit |
String |
计量单位。 |
time_filters |
String |
统计周期(时间限定)。 |
dimensions |
String |
统计维度。 |
general_filters |
String |
统计口径和修饰词。 |
interval_type |
String |
刷新频率。 枚举值:
|
apply_scenario |
String |
应用场景。 |
technical_metric |
String |
关联技术指标,填写String类型替代Long类型。 |
technical_metric_name |
String |
关联技术指标名称,只读。 |
technical_metric_type |
String |
业务实体类型。 枚举值:
|
measure |
String |
度量对象。 |
owner |
String |
指标责任人。 |
owner_department |
String |
指标管理部门。 |
destination |
String |
设置目的。 |
guid |
String |
资产同步后的guid,只读。 |
definition |
String |
指标定义。 |
expression |
String |
计算公式。 |
remark |
String |
备注。 |
approval_info |
ApprovalVO object |
审批信息,只读参数。业务对象最近一次的审批信息,包括审批的业务详情、审核人信息、审核时间等。 |
new_biz |
BizVersionManageVO object |
业务版本管理,只读。 |
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。 |
l1 |
String |
主题域分组中文名,只读,创建和更新时无需填写。 |
l2 |
String |
主题域中文名,只读,创建和更新时无需填写。 |
l3 |
String |
业务对象中文名,只读,创建和更新时无需填写。 |
biz_metric |
String |
业务指标同步状态,只读。 |
summary_status |
String |
同步统计状态,只读。 |
self_defined_fields |
Array of SelfDefinedFieldVO objects |
自定义项 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
审批单ID,填写String类型替代Long类型。 |
tenant_id |
String |
项目ID,获取方式参考接口路径参数“project_id”。 |
name_ch |
String |
业务中文名。 |
name_en |
String |
业务英文名。 |
biz_id |
String |
业务ID,填写String类型替代Long类型。 |
biz_type |
String |
业务实体类型。 枚举值:
|
biz_info |
String |
序列化之后的业务详情,类型是string。 |
biz_info_obj |
Object |
业务详情,类型是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 |
String |
ID信息,填写String类型替代Long类型。 |
biz_type |
String |
业务实体类型。 枚举值:
|
biz_id |
String |
业务ID,填写String类型替代Long类型。 |
biz_info |
String |
业务对象信息。 |
status |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
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。 |
参数 |
参数类型 |
描述 |
---|---|---|
fd_name_ch |
String |
自定义项中文名。 |
fd_name_en |
String |
自定义项英文名。 |
not_null |
Boolean |
是否必填。 |
fd_value |
String |
属性值。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
请求示例
根据请求参数进行业务指标的修改。
PUT https://{endpoint}/v2/{project_id}/design/biz-metrics { "code" : "ZB000001", "biz_catalog_id" : "1200479561188536320", "name" : "test_update_biz_metrics", "name_alias" : "", "destination" : "业务人员对此业务指标的设置目的进行描述", "definition" : "比如:按月对数据库某张表的某个字段进行均值计算。", "expression" : "avg(table.column)", "data_origin" : "", "unit" : "", "time_filters" : "月度", "dimensions" : "test_czh_0305_001", "general_filters" : "", "interval_type" : "HOUR", "apply_scenario" : "", "technical_metric" : "", "measure" : "", "owner_department" : "data owner dept", "owner" : "ei_dayu_y00321344_01", "remark" : "该业务指标有啥需要注意的地方。", "self_defined_fields" : [ ], "id" : "1231249989901135872" }
响应示例
状态码: 200
Success,返回data数据是BizMetricVO。
{ "data" : { "value" : { "id" : "1231249989901135872", "name" : "test_update_biz_metrics", "code" : "ZB000001", "name_alias" : "", "biz_type" : null, "status" : "DRAFT", "biz_catalog_id" : "1200479561188536320", "biz_catalog_path" : null, "create_by" : "ei_dayu_y00321344_01", "update_by" : "ei_dayu_y00321344_01", "data_origin" : "", "unit" : "", "time_filters" : "月度", "dimensions" : "test_czh_0305_001", "general_filters" : "", "interval_type" : "HOUR", "apply_scenario" : "", "technical_metric" : null, "technical_metric_name" : null, "technical_metric_type" : null, "measure" : "", "owner" : "ei_dayu_y00321344_01", "owner_department" : "data owner dept", "destination" : "业务人员对此业务指标的设置目的进行描述", "guid" : null, "definition" : "比如:按月对数据库某张表的某个字段进行均值计算。", "expression" : "avg(table.column)", "remark" : "该业务指标有啥需要注意的地方。", "approval_info" : null, "new_biz" : null, "create_time" : "2024-04-20T14:27:53+08:00", "update_time" : "2024-04-20T14:31:44.232+08:00", "l1" : null, "l2" : null, "l3" : null, "biz_metric" : null, "summary_status" : null, "self_defined_fields" : [ ] } } }
状态码: 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数据是BizMetricVO。 |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |