Querying Dimensions

Function

This API is used to query dimensions based on the name, description, creator, approver, status, l3 ID, list of IDs of derivative metrics, and modification time and display the results on different pages.

URI

GET /v2/{project_id}/design/dimensions

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
name	No	String	Fuzzy query by name or code
create_by	No	String	Creator
approver	No	String	Approver
status	No	String	Business status Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
l2_id	No	Long	ID of subject area l2
derivative_ids	No	Array	Parameters for querying dimensions based on the compound metric ID list
begin_time	No	String	Left boundary for a time filter. This parameter must be used together with end_time.
end_time	No	String	Right boundary for a time filter. This parameter must be used together with begin_time.
fact_logic_id	No	Long	Fact table ID
dimension_type	No	String	Dimension type Enumeration values: COMMON LOOKUP HIERARCHIES
limit	No	Integer	Number of records to be queried, that is, Y records. The value ranges from 1 to 100. The default value is 50. Maximum: 100 Default: 50
offset	No	Integer	Query offset, that is, X data records are skipped. The value must be 0 or an integer multiple of limit. If the value does not meet the requirements, it will be rounded down. The default value is 0. Default: 0
biz_catalog_id	No	String	Business catalog ID

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	Long	ID
name_en	String	Dimension name in English Maximum: 200
dimension_type	String	Dimension type Default: COMMON Enumeration values: COMMON LOOKUP HIERARCHIES
name_ch	String	Dimension name in Chinese Maximum: 200
description	String	Maximum: 600
create_by	String	Creator
update_by	String	User who updated the dimension
code_table_id	Long	Lookup table ID
code_table	CodeTableVO object	Lookup table
l1_id	Long	Subject area group ID
l2_id	String	Subject area ID
l3_id	Long	Business object ID
hierarchies	Array of DimensionHierarchiesVO objects	Hierarchies
status	String	Business statuses Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
create_time	String	Creation time
update_time	String	Update time
approval_info	ApprovalVO object	Approval information
new_biz	BizVersionManageVO object	Business version management
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
attributes	Array of DimensionAttributeVO objects	Dimension attributes
mappings	Array of TableMappingVO objects	Table mappings
datasource	BizDatasourceRelationVO object	Data source information
owner	String	Asset owner
table_type	String	Table type
distribute	String	DISTRIBUTE BY [HASH(column)\|REPLICATION] Enumeration values: HASH REPLICATION
distribute_column	String	DISTRIBUTE BY HASH column
alias	String	Alias
self_defined_fields	Array of SelfDefinedFieldVO objects	Custom fields

**Table 4** CodeTableVO
Parameter	Type	Description
id	Long	ID
name_en	String	Table name in English Maximum: 200
name_ch	String	Table name in Chinese Maximum: 200
tb_version	Integer	Table version
directory_id	Long	Catalog ID
directory_path	String	Catalog tree
description	String	Description Maximum: 600
create_by	String	Creator
status	String	Business statuses Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
create_time	String	Creation time
update_time	String	Update time
approval_info	ApprovalVO object	Approval information
new_biz	BizVersionManageVO object	Business version management
code_table_fields	Array of CodeTableFieldVO objects	Lookup table attribute information

**Table 5** 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 6** 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

**Table 7** CodeTableFieldVO
Parameter	Type	Description
id	Long	ID
code_table_id	Long	Lookup table ID
ordinal	Integer	Ordinal
name_en	String	Field name in English Maximum: 600
name_ch	String	Field name in Chinese Maximum: 200
description	String	Description Maximum: 600
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_unique_key	Boolean	Whether the attribute is unique Default: false
code_table_field_values	Array of CodeTableFieldValueVO objects	Lookup table attribute value
count_field_values	Integer	Number of lookup table attribute values

**Table 8** CodeTableFieldValueVO
Parameter	Type	Description
id	Long	ID
fd_id	Long	Lookup table attribute ID
fd_value	String	Lookup table attribute value
ordinal	Integer	Ordinal
description	String	Description Maximum: 600

**Table 9** 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 10** 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 11** 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 12** 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 13** TableMappingVO
Parameter	Type	Description
id	Long	ID
name	String	Name
description	String	Maximum: 600
target_table_id	Long	Destination table ID
src_model_id	Long	Model ID for the source table
src_model_name	String	Source model name
view_text	String	Source view. The DWS view is used reversely.
target_table_name	String	Destination table name
details	Array of TableMappingDetailVO objects	Details
source_tables	Array of MappingSourceTableVO objects	Source tables
source_fields	Array of MappingSourceFieldVO objects	Source fields
create_time	String	Creation time
update_time	String	Update time
create_by	String	Creator
update_by	String	User who updated the table mapping

**Table 14** TableMappingDetailVO
Parameter	Type	Description
id	Long	ID
mapping_id	String	Mapping ID
target_attr_id	Long	Destination field ID
target_attr_name	String	Target attribute name
src_table_ids	String	ID of a source table
src_table_names	Array of strings	Source table names
src_table_db_names	Array of strings	Database names in the source table
src_table_model_ids	Array of integers	IDs of source table models
src_table_id_list	Array of integers	IDs of source tables
src_attr_ids	String	ID of a source table attribute
src_attr_names	Array of strings	Names of source table attributes
src_attr_id_list	Array of integers	IDs of source table attributes
remark	String	Remarks
create_time	String	Creation time
update_time	String	Update time
create_by	String	Creator
update_by	String	User who updated the table mapping details
target_attr	Object	Target attribute

**Table 15** MappingSourceTableVO
Parameter	Type	Description
table1_id	Long	Table ID
table2_id	Long	Table ID Default: 0
table1_name	String	Table 1 name
table2_name	String	Table 2 name
join_type	String	Association type Default: LEFT Enumeration values: LEFT RIGHT INNER FULL
join_fields	Array of MappingJoinFieldVO objects	ON clause

**Table 16** MappingJoinFieldVO
Parameter	Type	Description
field1_id	Long	Attribute ID
field2_id	Long	Attribute ID
field1_name	String	Name of join field 1
field2_name	String	Name of join field 2

**Table 17** MappingSourceFieldVO
Parameter	Type	Description
target_field_id	Long	Target field ID. The target field is a field in the current table.
target_field_name	String	Target field name
field_ids	String	IDs of source fields. Multiple IDs are separated by commas (,).
transform_expression	String	Conversion expression
field_names	Array of strings	Names of source fields
changed	Boolean	Whether the field has changed

**Table 18** BizDatasourceRelationVO
Parameter	Type	Description
id	Long	ID
biz_id	Long	Business object information
biz_type	String	Business object 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
dw_type	String	Data connection type
dw_id	String	Data connection ID
dw_name	String	Data connection name
db_name	String	Database name
queue_name	String	Queue required for a DLI data connection to execute SQL statements. This parameter is mandatory for DLI data connections.
schema	String	Schema, which is required for DWS

**Table 19** 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 20** 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 21** 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 22** 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. The DimensionVO array and the total number of dimensions are returned.

{
  "id" : "873251051724242944",
  "name_en" : "dim_vendor",
  "dimension_type" : "LOOKUP",
  "name_ch" : "Vendor",
  "description" : "None",
  "create_by" : "abc",
  "update_by" : null,
  "code_table_id" : "873235088123527168",
  "code_table" : null,
  "l1_id" : "873232498044411904",
  "l2_id" : "873232798230675456",
  "l3_id" : "873233599258927104",
  "hierarchies" : [ ],
  "status" : "PUBLISHED",
  "create_time" : "2021-08-06T17:07:55+08:00",
  "update_time" : "2021-08-06T17:36:03+08:00",
  "approval_info" : {
    "id" : "873258129008336896",
    "tenant_id" : null,
    "name_ch" : null,
    "name_en" : null,
    "biz_id" : "873251051724242944",
    "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-06T17:36:02+08:00",
    "create_by" : null,
    "l1" : null,
    "l2" : null,
    "l3" : null,
    "approval_time" : "2021-08-06T17:36:03+08:00",
    "approver" : "abc",
    "email" : null,
    "msg" : "Fast Approval OK.",
    "directory_path" : null
  },
  "new_biz" : null,
  "l1" : "City traffic",
  "l2" : "Corporation",
  "l3" : "Vendor",
  "attributes" : [ {
    "id" : "873251051732631552",
    "dimension_id" : "873251051724242944",
    "code_table_field_id" : null,
    "name_en" : "vendor_id",
    "name_ch" : "Vendor ID",
    "description" : "",
    "create_by" : "abc",
    "data_type" : "BIGINT",
    "domain_type" : "NUMBER",
    "data_type_extend" : null,
    "is_primary_key" : true,
    "is_biz_primary" : true,
    "is_partition_key" : false,
    "ordinal" : 1,
    "not_null" : true,
    "stand_row_id" : null,
    "stand_row_name" : null,
    "quality_infos" : null,
    "status" : null,
    "create_time" : "2021-08-06T17:07:55+08:00",
    "update_time" : "2021-10-14T10:54:54+08:00",
    "alias" : null,
    "self_defined_fields" : null
  }, {
    "id" : "873251051732631553",
    "dimension_id" : "873251051724242944",
    "code_table_field_id" : null,
    "name_en" : "vendor_value",
    "name_ch" : "Vendor",
    "description" : "",
    "create_by" : "abc",
    "data_type" : "STRING",
    "domain_type" : "STRING",
    "data_type_extend" : null,
    "is_primary_key" : false,
    "is_biz_primary" : false,
    "is_partition_key" : false,
    "ordinal" : 2,
    "not_null" : false,
    "stand_row_id" : null,
    "stand_row_name" : null,
    "quality_infos" : null,
    "status" : null,
    "create_time" : "2021-08-06T17:07:55+08:00",
    "update_time" : "2021-10-14T10:54:54+08:00",
    "alias" : null,
    "self_defined_fields" : null
  } ],
  "mappings" : null,
  "datasource" : {
    "id" : "873251051745214464",
    "biz_id" : "873251051724242944",
    "biz_type" : "DIMENSION",
    "dw_type" : "DLI",
    "dw_id" : "2c9080f07b03db8d017b198a4a20002f",
    "dw_name" : null,
    "db_name" : "demo_dwr_db",
    "queue_name" : "dgc_dli_test",
    "schema" : ""
  },
  "owner" : "abc",
  "table_type" : "MANAGED",
  "distribute" : null,
  "distribute_column" : null,
  "alias" : "",
  "self_defined_fields" : null
}