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

Querying Summary Table Details

Function

This API is used to query the details of a summary table based on the ID.

URI

GET /v2/{project_id}/design/aggregation-logic-tables/{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

tb_name

String

Table name

Maximum: 600

tb_logic_name

String

Logical entity name

Maximum: 200

l1_id

Long

Subject area group ID

l2_id

String

Subject area ID

l3_id

Long

Business object GUID

description

String

Maximum: 600

owner

String

Asset owner

create_by

String

Creator

queue_name

String

Queue required for a DLI data connection to execute SQL statements. This parameter is mandatory for DLI data connections.

dw_id

String

Data connection ID

db_name

String

Database name

tb_id

String

Data table ID

schema

String

Schema, which is required for DWS

dw_name

String

Data connection name

status

String

Business statuses

Enumeration values:

  • DRAFT

  • PUBLISH_DEVELOPING

  • PUBLISHED

  • OFFLINE_DEVELOPING

  • OFFLINE

  • REJECT

tb_guid

String

GUID of the physical table corresponding to the published table

tb_logic_guid

String

GUID of the logical entity corresponding to the published table

dw_type

String

Data connection type

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

create_time

String

Creation time

update_time

String

Update time

approval_info

ApprovalVO object

Approval information

new_biz

BizVersionManageVO object

Business version management

dimension_group

String

Dimension group

Default: 0

group_name

String

Dimension group name

group_code

String

Dimension group code

time_period

AggregationLogicTableAttributeVO object

Time period of the summary table

table_attributes

Array of AggregationLogicTableAttributeVO objects

Summary table attributes. The type is determined by attribute_type.

physical_table

String

Table creation status

Enumeration values:

  • NO_NEED

  • CREATE_SUCCESS

  • CREATE_FAILED

  • UPDATE_SUCCESS

  • UPDATE_FAILED

  • SUMMARY_SUCCESS

  • SUMMARY_FAILED

  • RUNNING

  • OFFLINE

technical_asset

String

Technical asset synchronization status

Enumeration values:

  • NO_NEED

  • CREATE_SUCCESS

  • CREATE_FAILED

  • UPDATE_SUCCESS

  • UPDATE_FAILED

  • SUMMARY_SUCCESS

  • SUMMARY_FAILED

  • RUNNING

  • OFFLINE

business_asset

String

Logical asset synchronization status

Enumeration values:

  • NO_NEED

  • CREATE_SUCCESS

  • CREATE_FAILED

  • UPDATE_SUCCESS

  • UPDATE_FAILED

  • SUMMARY_SUCCESS

  • SUMMARY_FAILED

  • RUNNING

  • OFFLINE

meta_data_link

String

Asset association status

Enumeration values:

  • NO_NEED

  • CREATE_SUCCESS

  • CREATE_FAILED

  • UPDATE_SUCCESS

  • UPDATE_FAILED

  • SUMMARY_SUCCESS

  • SUMMARY_FAILED

  • RUNNING

  • OFFLINE

data_quality

String

Quality job status

Enumeration values:

  • NO_NEED

  • CREATE_SUCCESS

  • CREATE_FAILED

  • UPDATE_SUCCESS

  • UPDATE_FAILED

  • SUMMARY_SUCCESS

  • SUMMARY_FAILED

  • RUNNING

  • OFFLINE

dlf_task

String

Data development job status

Enumeration values:

  • NO_NEED

  • CREATE_SUCCESS

  • CREATE_FAILED

  • UPDATE_SUCCESS

  • UPDATE_FAILED

  • SUMMARY_SUCCESS

  • SUMMARY_FAILED

  • RUNNING

  • OFFLINE

publish_to_dlm

String

DLM API generation status

Enumeration values:

  • NO_NEED

  • CREATE_SUCCESS

  • CREATE_FAILED

  • UPDATE_SUCCESS

  • UPDATE_FAILED

  • SUMMARY_SUCCESS

  • SUMMARY_FAILED

  • RUNNING

  • OFFLINE

summary_status

String

Overall synchronization status

Enumeration values:

  • NO_NEED

  • CREATE_SUCCESS

  • CREATE_FAILED

  • UPDATE_SUCCESS

  • UPDATE_FAILED

  • SUMMARY_SUCCESS

  • SUMMARY_FAILED

  • RUNNING

  • OFFLINE

distribute

String

DISTRIBUTE BY [HASH(column)|REPLICATION]

Enumeration values:

  • HASH

  • REPLICATION

distribute_column

String

DISTRIBUTE BY HASH column

table_type

String

Table type

dlf_task_id

String

Data development job ID

quality_id

Long

Quality ID

reversed

Boolean

Whether the table model is reversed

Default: false

table_version

Integer

Table version. If the value is 2, the summary table is generated by data summarization.

partition_conf

String

Partition expression

dirty_out_switch

Boolean

Whether to export dirty data

Default: false

dirty_out_database

String

Database to which dirty data will be exported

dirty_out_prefix

String

Prefix of an abnormal table

dirty_out_suffix

String

Suffix of an abnormal table

alias

String

Alias

self_defined_fields

Array of SelfDefinedFieldVO objects

Custom fields

api_id

String

API ID

Table 4 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 5 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 6 AggregationLogicTableAttributeVO

Parameter

Type

Description

id

Long

ID

aggregation_logic_table_id

Long

Summary table ID

ordinal

Integer

Ordinal

name_en

String

Attribute name in English

Maximum: 600

name_ch

String

Attribute name in Chinese

Maximum: 200

attribute_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

is_primary_key

Boolean

Whether the attribute is a primary key

Default: false

is_partition_key

Boolean

Whether the attribute is a partition key

Default: false

not_null

Boolean

Whether the attribute is not null

Default: false

description

String

Maximum: 1000

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

ref_id

String

Association ID

stand_row_id

Long

ID of the associated data standard

stand_row_name

String

Maximum: 600

quality_infos

Array of QualityInfoVO objects

Quality information

alias

String

Alias

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. AggregationLogicTableVO is returned.

{
  "id" : "874242075850342400",
  "tb_name" : "dws_rate_code",
  "tb_logic_name" : "Rate code summary",
  "l1_id" : "873232498044411904",
  "l2_id" : "873232716601204736",
  "l3_id" : "873233519286059008",
  "description" : "None",
  "owner" : "abc",
  "create_by" : "abc",
  "queue_name" : "dgc_dli_test",
  "dw_id" : "2c9080f07b03db8d017b198a4a20002f",
  "db_name" : "demo_dm_db",
  "tb_id" : "NativeTable-2c9080f07b03db8d017b198a4a20002f-demo_dm_db-dws_rate_code",
  "schema" : "",
  "dw_name" : null,
  "status" : "PUBLISHED",
  "tb_guid" : "a268644b-31b6-42e5-84ec-e35c31b541a5",
  "tb_logic_guid" : "8948f715-3567-4684-9950-e3ed01e77121",
  "dw_type" : "DLI",
  "l1" : "City traffic",
  "l2" : "Trip record",
  "l3" : "Record statistics",
  "create_time" : "2021-08-09T10:45:54+08:00",
  "update_time" : "2021-09-26T15:36:53+08:00",
  "approval_info" : {
    "id" : "874242076399796224",
    "tenant_id" : null,
    "name_ch" : null,
    "name_en" : null,
    "biz_id" : "874242075850342400",
    "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-09T10:45:54+08:00",
    "create_by" : null,
    "l1" : null,
    "l2" : null,
    "l3" : null,
    "approval_time" : "2021-08-09T10:45:53+08:00",
    "approver" : "abc",
    "email" : null,
    "msg" : "Fast Approval OK.",
    "directory_path" : null
  },
  "new_biz" : null,
  "dimension_group" : "873252544997130240",
  "group_name" : "Rate code",
  "group_code" : null,
  "time_period" : {
    "id" : "874242075984560130",
    "aggregation_logic_table_id" : "874242075850342400",
    "ordinal" : 1,
    "name_en" : "dtime",
    "name_ch" : "Date",
    "attribute_type" : "SUMMARY_TIME",
    "is_primary_key" : false,
    "is_partition_key" : true,
    "not_null" : false,
    "description" : null,
    "data_type" : "TIMESTAMP",
    "domain_type" : "DATETIME",
    "data_type_extend" : null,
    "ref_id" : null,
    "stand_row_id" : null,
    "stand_row_name" : null,
    "quality_infos" : null,
    "alias" : null
  },
  "table_attributes" : [ {
    "id" : "874242075984560130",
    "aggregation_logic_table_id" : "874242075850342400",
    "ordinal" : 1,
    "name_en" : "dtime",
    "name_ch" : "Date",
    "attribute_type" : "SUMMARY_TIME",
    "is_primary_key" : false,
    "is_partition_key" : true,
    "not_null" : false,
    "description" : null,
    "data_type" : "TIMESTAMP",
    "domain_type" : "DATETIME",
    "data_type_extend" : null,
    "ref_id" : null,
    "stand_row_id" : null,
    "stand_row_name" : null,
    "quality_infos" : null,
    "alias" : null
  }, {
    "id" : "874242075984560131",
    "aggregation_logic_table_id" : "874242075850342400",
    "ordinal" : 2,
    "name_en" : "sum_total_amount",
    "name_ch" : "Total amount (rate code)",
    "attribute_type" : "DERIVATIVE_INDEX",
    "is_primary_key" : false,
    "is_partition_key" : false,
    "not_null" : false,
    "description" : "",
    "data_type" : "DOUBLE",
    "domain_type" : "NUMBER",
    "data_type_extend" : null,
    "ref_id" : "873265784540004352",
    "stand_row_id" : null,
    "stand_row_name" : null,
    "quality_infos" : null,
    "alias" : null
  }, {
    "id" : "874242075984560132",
    "aggregation_logic_table_id" : "874242075850342400",
    "ordinal" : 3,
    "name_en" : "dim_rate_code_rate_code_id",
    "name_ch" : "Rate code_ID",
    "attribute_type" : "SUMMARY_DIMENSION_ATTRIBUTE",
    "is_primary_key" : false,
    "is_partition_key" : false,
    "not_null" : true,
    "description" : "",
    "data_type" : "BIGINT",
    "domain_type" : "NUMBER",
    "data_type_extend" : null,
    "ref_id" : "873252544997130240.873258130849636352",
    "stand_row_id" : null,
    "stand_row_name" : null,
    "quality_infos" : null,
    "alias" : null
  }, {
    "id" : "874242075984560133",
    "aggregation_logic_table_id" : "874242075850342400",
    "ordinal" : 4,
    "name_en" : "dim_rate_code_rate_code_value",
    "name_ch" : "Rate code_description",
    "attribute_type" : "SUMMARY_DIMENSION_ATTRIBUTE",
    "is_primary_key" : false,
    "is_partition_key" : false,
    "not_null" : false,
    "description" : "",
    "data_type" : "STRING",
    "domain_type" : "STRING",
    "data_type_extend" : null,
    "ref_id" : "873252544997130240.873258130849636353",
    "stand_row_id" : null,
    "stand_row_name" : null,
    "quality_infos" : null,
    "alias" : null
  } ],
  "physical_table" : "CREATE_SUCCESS",
  "technical_asset" : "UPDATE_SUCCESS",
  "business_asset" : "UPDATE_SUCCESS",
  "meta_data_link" : "UPDATE_SUCCESS",
  "data_quality" : "UPDATE_SUCCESS",
  "dlf_task" : "CREATE_SUCCESS",
  "publish_to_dlm" : "NO_NEED",
  "summary_status" : "SUMMARY_SUCCESS",
  "distribute" : null,
  "distribute_column" : null,
  "table_type" : "MANAGED",
  "dlf_task_id" : "demo_dm_db_dws_rate_code_874242075850342400",
  "quality_id" : "874242188178075649",
  "reversed" : null,
  "table_version" : 0,
  "partition_conf" : null,
  "dirty_out_switch" : false,
  "dirty_out_database" : "",
  "dirty_out_prefix" : "",
  "dirty_out_suffix" : "",
  "alias" : "",
  "self_defined_fields" : [ ],
  "api_id" : null
}

Status Codes

Status Code

Description

200

The operation succeeds. AggregationLogicTableVO is returned.

400

BadRequest

401

Unauthorized

403

Forbidden