Querying Derivative Metric Details

Function

This API is used to query the details of a derivative metric with a specified ID.

URI

GET /v2/{project_id}/design/derivative-indexs/{id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
id	Yes	String	Entity ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
latest	No	Boolean	Whether to query the latest data

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	Long	ID
name_en	String	Derivative metric name in English Maximum: 200
name_ch	String	Derivative metric name in Chinese Maximum: 200
description	String	Maximum: 600
create_by	String	Creator
data_type	String	Data type
l1_id	Long	Subject area group ID
l2_id	String	Subject area ID
l3_id	Long	Business object GUID
status	String	Business statuses Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
atomic_index_id	Long	Atomic metric ID
time_condition_id	Long	Time filter ID
time_field_id	Long	ID of the field associated with the time filter
time_field_name	String	Name of the field associated with the time filter
common_conditions	Array of CommonConditionVO objects	Common filters
dimension_groups	Array of DerivativeIndexDimensionVO objects	Dimension group (granularity)
monitor	MetricMonitorVO object	Metric monitoring
atomic_index	AtomicIndexVO object	Atomic metric information, including the name and unit
time_condition_name	String	Time filter name
create_time	String	Creation time
update_time	String	Update time
l1	String	Chinese name of the subject area group
l2	String	Chinese name of the subject area
l3	String	Chinese name of the business object
summary_table_id	Long	Summary table ID
approval_info	ApprovalVO object	Approval information
new_biz	BizVersionManageVO object	Business version management

**Table 4** CommonConditionVO
Parameter	Type	Description
name	String	Name
field_ids	Array of strings	Field ID, in the table_id.field_id format
field_names	Array of strings	Field name, in the Table name.Field name format
cal_exp	String	Calculation expression Maximum: 20000
cal_fn_ids	Array of integers	Calculation expression ID
front_configs	String	Frontend expression configuration, which is used for frontend data restoration
id	Long	id

**Table 5** DerivativeIndexDimensionVO
Parameter	Type	Description
group_id	String	Dimension group ID
role	String	Dimension role
dimension_id	Long	Dimension ID
hierarchies_id	Long	Hierarchy ID
ordinal	Integer	Ordinal
group_name	String	Dimension group name
group_code	String	Dimension group code
biz_type	String	Business types Enumeration values: 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
hierarchies	Array of DimensionHierarchiesVO objects	Hierarchy attributes
l1	String	Subject area group
l2	String	Subject area
l3	String	Business object
l1_id	Long	Subject area group ID
l2_id	String	Subject area ID
l3_id	Long	Business object ID
dw_type	String	Data connection type
id	Long	id

**Table 6** DimensionHierarchiesVO
Parameter	Type	Description
id	Long	ID
name	String	Hierarchy name Maximum: 600
attrs	Array of HierarchiesAttrVO objects	Hierarchy attribute
create_time	String	Creation time
update_time	String	Update time
create_by	String	Creator
update_by	String	User who updated the dimension hierarchy

**Table 7** HierarchiesAttrVO
Parameter	Type	Description
id	Long	ID
hierarchies_id	Long	Hierarchy ID
attr_id	Long	Attribute ID
level	Integer	Level
attr_name_en	String	Hierarchy attribute name in English
attr_name_ch	String	Hierarchy attribute name in Chinese
detail_attr_ids	Array of integers	IDs of detail attributes
detail_attr_name_ens	Array of strings	Detail attribute name in English
detail_attr_name_chs	Array of strings	Detail attribute name in Chinese
attr	DimensionAttributeVO object	Hierarchy attribute field
detail_attrs	Array of DimensionAttributeVO objects	Detail attributes

**Table 8** DimensionAttributeVO
Parameter	Type	Description
id	Long	ID
dimension_id	Long	Dimension ID
code_table_field_id	Long	Lookup table attribute ID
name_en	String	Dimension attribute name in English Maximum: 600
name_ch	String	Dimension attribute name in Chinese Maximum: 200
description	String	Maximum: 600
create_by	String	Creator
data_type	String	Data type
domain_type	String	Data type domains Enumeration values: NUMBER STRING DATETIME BLOB OTHER
data_type_extend	String	Data type extended field Maximum: 50
is_primary_key	Boolean	Whether the attribute is a primary key Default: false
is_biz_primary	Boolean	Whether the attribute is a business primary key Default: false
is_partition_key	Boolean	Whether the attribute is a partition key Default: false
ordinal	Integer	Ordinal
not_null	Boolean	Whether the attribute is not null Default: false
stand_row_id	Long	ID of the associated data standard
stand_row_name	String	Maximum: 600
quality_infos	Array of QualityInfoVO objects	Quality information
status	String	Business statuses Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
create_time	String	Creation time
update_time	String	Update time
alias	String	Alias
self_defined_fields	Array of SelfDefinedFieldVO objects	Custom fields

**Table 9** QualityInfoVO
Parameter	Type	Description
id	Long	ID
table_id	Long	Table ID
attr_id	Long	Attribute ID
biz_type	String	Business types Enumeration values: 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
data_quality_id	Long	Quality ID
show_control	Integer	Whether to display the regular expression
data_quality_name	String	Quality name
alert_conf	String	Alarm configuration
expression	String	Regular expression in verification rules
extend_info	String	Extended information
from_standard	Boolean	Whether the quality information is from data standard quality configuration Default: false
result_description	String	Result description
create_by	String	Creator
update_by	String	User who updated the quality information
create_time	String	Creation time
update_time	String	Update time

**Table 10** SelfDefinedFieldVO
Parameter	Type	Description
fd_name_ch	String	Custom field name in Chinese Maximum: 200
fd_name_en	String	Custom field name in English Maximum: 200
not_null	Boolean	Whether the field is mandatory
fd_value	String	Field value

**Table 11** MetricMonitorVO
Parameter	Type	Description
id	Long	ID
other_metric_ids	Array of integers	IDs of other metrics
other_metric_names	Array of strings	Names of other metrics
expression	String	Alarm expression Maximum: 2000
metric_id	Long	Metric ID
front_configs	String	Frontend expression configuration, which is used for frontend data restoration
metric_type	String	Metric type Enumeration values: 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

**Table 12** AtomicIndexVO
Parameter	Type	Description
id	Long	ID
name_en	String	Atomic index name in English Maximum: 200
name_ch	String	Atomic index name in Chinese Maximum: 200
description	String	Maximum: 600
create_by	String	Creator
cal_exp	String	Calculation expression Maximum: 200
cal_fn_ids	Array of integers	Calculation expression ID
l1_id	Long	Subject area group ID
l2_id	String	Subject area ID
l3_id	Long	Business object GUID
table_id	Long	Table ID
tb_name	String	Table name
dw_type	String	Data connection type
field_ids	Array of integers	Field ID
field_names	Array of strings	Field names
status	String	Business statuses Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
biz_type	String	Business types Enumeration values: 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
create_time	String	Creation time
update_time	String	Update time
l1	String	Chinese name of the subject area group
l2	String	Chinese name of the subject area
l3	String	Chinese name of the business object
approval_info	ApprovalVO object	Approval information
new_biz	BizVersionManageVO object	Business version management

**Table 13** ApprovalVO
Parameter	Type	Description
id	Long	ID
tenant_id	String	tenant id
name_ch	String	Approval name in Chinese
name_en	String	Approval name in English
biz_id	Long	Business ID
biz_type	String	Business types Enumeration values: 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
biz_info	String	Business information
biz_info_obj	Object	Business information object
biz_version	Integer	Business version
biz_status	String	Business statuses Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
approval_status	String	Approval statuses Enumeration values: DEVELOPING APPROVED REJECT WITHDREW
approval_type	String	Approval types Enumeration values: PUBLISH OFFLINE
submit_time	String	Submission time
create_by	String	Creator
l1	String	Subject area group
l2	String	Subject area
l3	String	Business object
approval_time	String	Approval time
approver	String	Approver
email	String	Approver email address
msg	String	Approval message
directory_path	String	Directory tree

**Table 14** BizVersionManageVO
Parameter	Type	Description
id	Long	ID information
biz_type	String	Business types Enumeration values: 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
biz_id	Long	Business ID
biz_info	String	Business object information
status	String	Business statuses Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
biz_version	Integer	Business version
create_time	String	Creation time
update_time	String	Update time

Status code: 400

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.000 which indicates that the request was successfully processed.
error_msg	String	Error message
data	Object	Returned data

Status code: 401

**Table 16** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.000 which indicates that the request was successfully processed.
error_msg	String	Error message
data	Object	Returned data

Status code: 403

**Table 17** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.000 which indicates that the request was successfully processed.
error_msg	String	Error message
data	Object	Returned data

Example Requests

None

Example Responses

Status code: 200

The operation succeeds. DerivativeIndexVO is returned.

{
  "id" : "873265784540004352",
  "name_en" : "sum_total_amount",
  "name_ch" : "Total amount (rate code)",
  "description" : "",
  "create_by" : "abc",
  "data_type" : "DOUBLE",
  "l1_id" : "873232498044411904",
  "l2_id" : "873232716601204736",
  "l3_id" : "873233519286059008",
  "status" : "PUBLISHED",
  "atomic_index_id" : "873264909264257024",
  "time_condition_id" : null,
  "time_field_id" : null,
  "time_field_name" : null,
  "common_conditions" : [ ],
  "dimension_groups" : [ {
    "group_id" : "873252544997130240",
    "role" : null,
    "dimension_id" : "873252544997130240",
    "hierarchies_id" : null,
    "ordinal" : 1,
    "group_name" : "Rate code",
    "group_code" : "dim_rate_code",
    "biz_type" : "DIMENSION",
    "hierarchies" : null,
    "l1" : null,
    "l2" : null,
    "l3" : null,
    "l1_id" : null,
    "l2_id" : null,
    "l3_id" : null,
    "dw_type" : null,
    "id" : "873265784602918912"
  } ],
  "monitor" : null,
  "atomic_index" : {
    "id" : "873264909264257024",
    "name_en" : "sum_total_amount",
    "name_ch" : "Total amount",
    "description" : "",
    "create_by" : null,
    "cal_exp" : "sum(${873264563087376397})",
    "cal_fn_ids" : null,
    "l1_id" : null,
    "l2_id" : null,
    "l3_id" : null,
    "table_id" : "873264563070599168",
    "tb_name" : null,
    "dw_type" : null,
    "field_ids" : [ "873264563087376397" ],
    "field_names" : null,
    "status" : "DRAFT",
    "biz_type" : "FACT_LOGIC_TABLE",
    "create_time" : "2022-08-30T21:28:45.454+08:00",
    "update_time" : "2022-08-30T21:28:45.454+08:00",
    "l1" : null,
    "l2" : null,
    "l3" : null,
    "approval_info" : null,
    "new_biz" : null
  },
  "time_condition_name" : null,
  "create_time" : "2021-08-06T18:06:28+08:00",
  "update_time" : "2021-08-06T18:06:27+08:00",
  "l1" : "City traffic",
  "l2" : "Trip record",
  "l3" : "Record statistics",
  "summary_table_id" : null,
  "approval_info" : {
    "id" : "873265785332727808",
    "tenant_id" : null,
    "name_ch" : null,
    "name_en" : null,
    "biz_id" : "873265784540004352",
    "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-06T18:06:28+08:00",
    "create_by" : null,
    "l1" : null,
    "l2" : null,
    "l3" : null,
    "approval_time" : "2021-08-06T18:06:27+08:00",
    "approver" : "abc",
    "email" : null,
    "msg" : "Fast Approval OK.",
    "directory_path" : null
  },
  "new_biz" : null
}