新建衍生指标
功能介绍
根据参数,新建衍生指标指标。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/design/derivative-indexs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
[数组元素] |
是 |
Array of DerivativeIndexVO objects |
创建衍生指标的请求体参数。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
衍生指标ID,ID字符串。更新时必填。 |
name_en |
是 |
String |
衍生指标英文名称。 |
name_ch |
是 |
String |
衍生指标名称。 |
create_by |
否 |
String |
创建人。 |
data_type |
否 |
String |
字段类型。 |
l2_id |
否 |
String |
主题域ID。 |
l3_id |
是 |
String |
业务对象guid,ID字符串。 |
status |
否 |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
atomic_index_id |
是 |
String |
原子指标ID,ID字符串。 |
time_condition_id |
否 |
String |
时间限定ID,ID字符串。 |
time_field_id |
否 |
String |
时间限定关联字段ID,ID字符串。 |
common_conditions |
否 |
Array of CommonConditionVO objects |
通用限定信息。 |
dimension_groups |
否 |
Array of DerivativeIndexDimensionVO objects |
统计维度,更新时不可修改。 |
monitor |
否 |
MetricMonitorVO object |
指标监控。 |
l1 |
否 |
String |
主题域分组中文名,只读,创建和更新时无需填写。 |
l2 |
否 |
String |
主题域中文名,只读,创建和更新时无需填写。 |
l3 |
否 |
String |
业务对象中文名,只读,创建和更新时无需填写。 |
approval_info |
否 |
ApprovalVO object |
审批信息,只读参数。业务对象最近一次的审批信息,包括审批的业务详情、审核人信息、审核时间等。 |
new_biz |
否 |
BizVersionManageVO object |
业务版本管理,只读。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
名称。 |
field_ids |
是 |
Array of strings |
字段id信息,格式:table_id.field_id。 |
field_names |
否 |
Array of strings |
字段名称信息,格式:表名称.字段名称。 |
cal_exp |
是 |
String |
计算表达式,形如'${table_id.column_id} > 1',其中table_id表示引用字段所属表ID,column_id表示引用字段ID。 |
cal_fn_ids |
是 |
Array of strings |
引用函数ID,ID字符串。 |
front_configs |
否 |
String |
前端表达式配置,用于前端数据恢复。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_id |
是 |
String |
维度分组ID。 |
role |
否 |
String |
维度角色。 |
dimension_id |
否 |
String |
维度ID,ID字符串。 |
hierarchies_id |
否 |
String |
维度层级ID,ID字符串。 |
group_name |
否 |
String |
维度分组名称。 |
group_code |
否 |
String |
维度分组编码。 |
biz_type |
是 |
String |
业务实体类型。 枚举值:
|
l2_id |
否 |
String |
主题域ID。 |
dw_type |
否 |
String |
数据连接类型。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
编码,ID字符串。 |
other_metric_ids |
否 |
Array of strings |
其他指标ID,ID字符串。 |
other_compound_metric_ids |
否 |
Array of strings |
其他复合指标ID。 |
expression |
否 |
String |
告警表达式。 |
metric_id |
否 |
String |
挂载指ID,ID字符串。 |
front_configs |
否 |
String |
前端表达式配置,用于前端数据恢复。 |
metric_type |
否 |
String |
挂载指标类型。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
审批单ID,ID字符串。 |
tenant_id |
否 |
String |
项目ID,获取方式参考接口路径参数“project_id”。 |
name_ch |
否 |
String |
业务中文名。 |
name_en |
否 |
String |
业务英文名。 |
biz_id |
否 |
String |
业务ID,ID字符串。 |
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信息,ID字符串。 |
biz_type |
否 |
String |
业务实体类型。 枚举值:
|
biz_id |
否 |
String |
业务ID,ID字符串。 |
biz_info |
否 |
String |
业务对象信息。 |
status |
否 |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
data object |
创建衍生指标的返回结果,成功的个数。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
批量审批ID,ID字符串。 |
tenant_id |
String |
项目ID。 |
group_id |
String |
组ID,ID字符串。 |
biz_name |
String |
业务名。 |
biz_id |
String |
业务ID,ID字符串。 |
operation_status |
String |
操作结果类型枚举。RUNNING(运行中)、SUCCESS(操作成功)、FAILED(操作失败)。 枚举值:
|
operation_type |
String |
类型。 |
biz_info |
String |
业务详情。 |
create_by |
String |
创建人。 |
remark |
String |
remark信息。 |
total |
Integer |
总数。 |
success |
Integer |
操作成功个数。 |
failed |
Integer |
操作失败个数。 |
rate |
String |
当前进度。 |
logs |
String |
日志。 |
groups |
Array of BatchOperationVO objects |
分组信息。 |
状态码: 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 |
返回的数据信息。 |
请求示例
根据请求参数进行衍生指标的创建。
POST https://{endpoint}/v2/{project_id}/design/derivative-indexs [ { "name_ch" : "总车费(供应商,行程订单.车费)", "name_en" : "sum_total_amount", "data_type" : "STRING", "l3_id" : "1169309252771299328", "atomic_index_id" : "1170005876631875584", "dimension_groups" : [ { "biz_type" : "DIMENSION", "group_id" : "1169322847009742848", "group_name" : "供应商", "dimension_id" : "1169322847009742848", "role" : null, "hierarchies_id" : null }, { "biz_type" : "DEGENERATE_DIMENSION", "group_id" : "1169329693619625984.1169329693695123463", "group_name" : "行程订单.车费", "dimension_id" : null, "role" : null, "hierarchies_id" : null } ], "time_condition_id" : null, "time_field_id" : null, "common_conditions" : [ ], "monitor" : null, "description" : "" } ]
响应示例
状态码: 200
Success,返回data数据是 BatchOperationVO。
{ "data" : { "value" : { "id" : null, "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "group_id" : "1300493983935508480", "biz_name" : null, "biz_id" : null, "operation_status" : "SUCCESS", "operation_type" : "BATCH_CREATE", "biz_info" : null, "create_by" : "test_uesr", "remark" : null, "total" : 1, "success" : 1, "failed" : 0, "rate" : "1.00", "logs" : null, "groups" : [ { "id" : "1300493984405270528", "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "group_id" : "1300493983935508480", "biz_name" : "总车费(供应商,行程订单.车费)", "biz_id" : "1300493984245886976", "operation_status" : "SUCCESS", "operation_type" : "BATCH_CREATE", "biz_info" : "{\"atomic_index_id\":1170005876631875584,\"create_by\":\"test_uesr\",\"data_type\":\"STRING\",\"description\":\"\",\"id\":1300493984245886976,\"l3_id\":1169309252771299328,\"name_ch\":\"总车费(供应商,行程订单.车费)\",\"name_en\":\"sum_total_amount\",\"status\":\"DRAFT\"}", "create_by" : "test_uesr", "remark" : "CREATE", "total" : 0, "success" : 0, "failed" : 0, "rate" : null, "logs" : null, "groups" : null } ] } } }
状态码: 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数据是 BatchOperationVO。 |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |