Obtaining Relationship Information of a Metric

Function

This API is used to obtain the graphs of a specified metric.

URI

GET /v2/{project_id}/design/metric-relations/{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
biz_type	Yes	String	Metric type

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Quantity
all	Array of MetricRelationVO objects	Information about all objects
groups	Object	Statistical dimension information
links	MetricRelationVO object	Information about links

**Table 4** MetricRelationVO
Parameter	Type	Description
vo	Object	Business object
id	Long	Object 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
child_ids	Array of strings	IDs of subobjects
parent_ids	Array of strings	IDs of parent objects
tables	Array of MetricRelationVO objects	Associated table

Status code: 400

**Table 5** 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 6** 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 7** 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, and MetricRelationVOList is returned.

{
  "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" ]
  }
}