Querying Dimension Groups

Updated on 2022-09-15 GMT+08:00

View PDF

Function

This API is used to query dimension groups based on tableId. If tableId is not specified, all dimension groups will be queried.

URI

GET /v2/{project_id}/design/dimension/groups

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
table_id	No	Long	ID of the associated table
biz_type	No	String	Business types

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
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 4** 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 5** 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 6** 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 7** 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 8** 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

Status code: 400

**Table 9** 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 10** 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 11** 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. DerivativeIndexDimensionVO is returned.

{
  "group_id" : "873264563070599168.873264563087376390",
  "role" : null,
  "dimension_id" : null,
  "hierarchies_id" : null,
  "ordinal" : null,
  "group_name" : "Trip order.Drop-off location",
  "group_code" : "fact_stroke_order.do_location_id",
  "biz_type" : null,
  "hierarchies" : null,
  "l1" : null,
  "l2" : null,
  "l3" : null,
  "l1_id" : null,
  "l2_id" : null,
  "l3_id" : null,
  "dw_type" : "DLI",
  "id" : null
}