Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ ER Modeling/ Viewing Table Model Details
Updated on 2025-11-17 GMT+08:00
View PDF

Viewing Table Model Details

Function

This API is used to obtain model table details by ID.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/design/table-model/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

id

Yes

String

Entity ID, which is a string
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

latest

No

Boolean

Indicates whether to query the latest.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header).

This field is mandatory for authentication using tokens.

workspace

Yes

String

Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

X-Project-Id

No

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios.

Content-Type

No

String

Default value: application/json;charset=UTF-8

This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

data object

data: unified outermost data structure of the returned result.
Table 5 data

Parameter

Type

Description

value

TableModelVO object

value: unified outer data structure of the returned result.
Table 6 TableModelVO

Parameter

Type

Description

id

String

ID, which is a string

model_id

String

ID of the relational model, which is a string

parent_table_id

String

Parent table ID, which is a string

parent_table_name

String

Parent table name, which is read-only.

parent_table_code

String

Parent table code, which is read-only.

related_logic_table_id

String

ID of the associated logical entity, which is a string

related_logic_table_name

String

Name of an associated logical entity.

related_logic_table_model_id

String

ID of the model associated with a logical entity, which is a string

related_logic_table_model_name

String

Name of the model associated with a logical entity.

model

WorkspaceVO object

Model information

data_format

String

Data Format,

obs_bucket

String

OBS bucket.

obs_location

String

Foreign Table Path

configs

String

Other configurations.

table_type

String

Table type, which is read-only.

owner

String

Person in charge.

tb_name

String

Table name.

dw_id

String

Data connection ID.

db_name

String

Indicates the database name.

queue_name

String

Queue required for executing SQL statements through the DLI data connection. This parameter is mandatory when the data connection type is DLI.

schema

String

Required by the DWS type.

extend_info

String

Indicates the extension information.

tb_guid

String

GUID after table materialization. This parameter is read-only.

tb_id

String

Data table ID. This parameter is read-only.

logic_tb_name

String

Name of a logical entity.

logic_tb_guid

String

GUID of a logical entity. This parameter is read-only.

description

String

Description.

status

String

Release status of an entity. This parameter is read-only and does not need to be set during creation and update.

Options:

  • DRAFT: draft

  • PUBLISH_DEVELOPING: to be reviewed

  • PUBLISHED: released

  • OFFLINE_DEVELOPING: to be reviewed

  • OFFLINE: offline

  • REJECT: rejected

logic_tb_id

String

ID of a logical entity, which is a string

biz_catalog_id

String

ID of the business catalog, which is a string

catalog_path

String

Path of the home service category: {"l1Id":"","l2Id":"","l3Id":""}.

create_by

String

Creator, which is read-only.

update_by

String

Updater, which is read-only.

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

tags

Array of TagRecordVO objects

Read-only table tags

approval_info

ApprovalVO object

Approval information. This parameter is read-only. Latest review information about a business object, including the business details, reviewer information, and review time.

new_biz

BizVersionManageVO object

Service version management. This parameter is read-only.

attributes

Array of TableModelAttributeVO objects

Table attribute information.

mappings

Array of TableMappingVO objects

Table mapping information.

relations

Array of RelationVO objects

Relationship.

dw_type

String

Data connection type, which corresponds to the type of the data warehouse where the table is located. The value can be DWS, MRS_HIVE, POSTGRESQL, MRS_SPARK, CLICKHOUSE, MYSQL, ORACLE, or DORIS.

dw_name

String

Data connection name. This parameter is read-only and does not need to be set when you create or update a data connection.

l1

String

Chinese name of the subject area group. This parameter is read-only and does not need to be set when you create or update a subject area group.

l2

String

Chinese name of the subject area. This parameter is read-only and does not need to be set during creation and update.

l3

String

Chinese name of the business object. This parameter is read-only and does not need to be set during creation and update.

l1_id

String

Subject area group ID, which is a read-only string

l2_id

String

Subject area ID. This parameter is read-only and does not need to be set during creation and update.

l3_id

String

Business object ID, which is a read-only string

partition_conf

String

Partition expression.

dlf_task_id

String

ID of a DLF job.

use_recently_partition

Boolean

Indicates whether to use the latest partition.

reversed

Boolean

Indicates whether it is reverse.

dirty_out_switch

Boolean

Indicates whether to output abnormal data.

dirty_out_database

String

Abnormal data output library.

dirty_out_prefix

String

Prefix of an exception table.

dirty_out_suffix

String

Suffix of an exception table.

quality_owner

String

Quality owner.

quality_id

String

Quality ID, which is a string

distribute

String

DISTRIBUTE BY [HASH(column)|REPLICATION].

Options:

  • HASH: Hashes specified columns and distributes data to specified DNs through mapping.

  • REPLICATION: Each row in the table exists on all DNs, that is, each DN has complete table data.

distribute_column

String

DISTRIBUTE BY HASH column.

is_partition

Boolean

Indicates whether the table is a partition table. This parameter is read-only.

physical_table

String

Synchronization status.

Options:

  • NO_NEED: not synchronized

  • CREATE_SUCCESS: The creation is successful.

  • CREATE_FAILED: Creation failed

  • UPDATE_SUCCESS: The update is successful.

  • UPDATE_FAILED: The update fails.

  • SUMMARY_SUCCESS: overall success

  • SUMMARY_FAILED: overall failure

  • RUNNING: overall running

  • OFFLINE: offline

dev_physical_table

String

Synchronization status.

Options:

  • NO_NEED: not synchronized

  • CREATE_SUCCESS: The creation is successful.

  • CREATE_FAILED: Creation failed

  • UPDATE_SUCCESS: The update is successful.

  • UPDATE_FAILED: The update fails.

  • SUMMARY_SUCCESS: overall success

  • SUMMARY_FAILED: overall failure

  • RUNNING: overall running

  • OFFLINE: offline

technical_asset

String

Synchronization status.

Options:

  • NO_NEED: not synchronized

  • CREATE_SUCCESS: The creation is successful.

  • CREATE_FAILED: Creation failed

  • UPDATE_SUCCESS: The update is successful.

  • UPDATE_FAILED: The update fails.

  • SUMMARY_SUCCESS: overall success

  • SUMMARY_FAILED: overall failure

  • RUNNING: overall running

  • OFFLINE: offline

business_asset

String

Synchronization status.

Options:

  • NO_NEED: not synchronized

  • CREATE_SUCCESS: The creation is successful.

  • CREATE_FAILED: Creation failed

  • UPDATE_SUCCESS: The update is successful.

  • UPDATE_FAILED: The update fails.

  • SUMMARY_SUCCESS: overall success

  • SUMMARY_FAILED: overall failure

  • RUNNING: overall running

  • OFFLINE: offline

meta_data_link

String

Synchronization status.

Options:

  • NO_NEED: not synchronized

  • CREATE_SUCCESS: The creation is successful.

  • CREATE_FAILED: Creation failed

  • UPDATE_SUCCESS: The update is successful.

  • UPDATE_FAILED: The update fails.

  • SUMMARY_SUCCESS: overall success

  • SUMMARY_FAILED: overall failure

  • RUNNING: overall running

  • OFFLINE: offline

data_quality

String

Synchronization status.

Options:

  • NO_NEED: not synchronized

  • CREATE_SUCCESS: The creation is successful.

  • CREATE_FAILED: Creation failed

  • UPDATE_SUCCESS: The update is successful.

  • UPDATE_FAILED: The update fails.

  • SUMMARY_SUCCESS: overall success

  • SUMMARY_FAILED: overall failure

  • RUNNING: overall running

  • OFFLINE: offline

summary_status

String

Synchronization status.

Options:

  • NO_NEED: not synchronized

  • CREATE_SUCCESS: The creation is successful.

  • CREATE_FAILED: Creation failed

  • UPDATE_SUCCESS: The update is successful.

  • UPDATE_FAILED: The update fails.

  • SUMMARY_SUCCESS: overall success

  • SUMMARY_FAILED: overall failure

  • RUNNING: overall running

  • OFFLINE: offline

dev_version

String

Development environment version, which is a read-only string

prod_version

String

Production environment version, which is a read-only string

dev_version_name

String

Version name of the development environment, which is read-only

prod_version_name

String

Version name of the production environment, which is read-only

env_type

String

Type of the development and production environment.

Options:

  • INVALID_TYPE: invalid environment

  • DEV_TYPE: development environment

  • PROD_TYPE: production environment

  • DEV_PROD_TYPE: development and production environment

alias

String

Alias

self_defined_fields

Array of SelfDefinedFieldVO objects

User-defined item.

code

String

Message

has_related_physical_table

Boolean

Indicates whether an associated physical table exists.

has_related_logic_table

Boolean

Indicates whether an associated logical entity exists.
Table 7 WorkspaceVO

Parameter

Type

Description

id

String

ID, which is a string

name

String

Name of the workspace.

description

String

Description.

is_physical

Boolean

Indicates whether a table is a physical table.

frequent

Boolean

Indicates whether it is commonly used.

top

Boolean

Hierarchical governance.

level

String

Data governance layers.

Options:

  • SDI: source data layer

  • DWI: data integration layer

  • DWR: data reporting layer

  • DM: data mart layer

dw_type

String

Data connection type, which corresponds to the type of the data warehouse where the table is located. The value can be DWS, MRS_HIVE, POSTGRESQL, MRS_SPARK, CLICKHOUSE, MYSQL, ORACLE, or DORIS.

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

create_by

String

Creator.

update_by

String

Person who updates the information.

type

String

Defines the workspace type enumeration.

Options:

  • THIRD_NF: relational modeling

  • DIMENSION: dimensional modeling

biz_catalog_ids

String

{"l1Ids":[],"l2Ids":[],"l3Ids":[]}: ID list of associated service catalogs.

databases

Array of strings

Array of database names.

table_model_prefix

String

Model verification prefix. The value contains a maximum of 100 characters, including digits, letters, and underscores (_), and starts with a letter.
Table 8 TagRecordVO

Parameter

Type

Description

id

String

ID, which is a string

tag_id

String

Tag ID, which is a string

tag_name

String

Tag name.

biz_id

String

Entity ID, which is a string

biz_type

String

Business entity type.

Options:

  • AGGREGATION_LOGIC_TABLE: summary table

  • ATOMIC_INDEX: atomic metric

  • ATOMIC_METRIC: atomic metric (new)

  • BIZ_CATALOG: process architecture directory

  • BIZ_METRIC: service indicator

  • CODE_TABLE: code table

  • COMMON_CONDITION: general filter

  • COMPOSITE_METRIC: Compound Metric (new)

  • COMPOUND_METRIC: compound metric

  • CONDITION_GROUP: restriction group

  • DEGENERATE_DIMENSION: degenerate dimension

  • DERIVATIVE_INDEX: derivative indicator

  • DERIVED_METRIC: derivative indicator (new)

  • DIMENSION: dimension

  • DIMENSION_ATTRIBUTE: dimension attribute

  • DIMENSION_HIERARCHIES: dimension level

  • DIMENSION_LOGIC_TABLE: dimension table

  • DIMENSION_TABLE_ATTRIBUTE: dimension attribute

  • DIRECTORY: directory

  • FACT_ATTRIBUTE: fact table attribute

  • FACT_DIMENSION: fact table dimension

  • FACT_LOGIC_TABLE: fact table

  • FACT_MEASURE: fact table measurement

  • FUNCTION: function

  • INFO_ARCH: information architecture (used for modifying themes in batches)

  • MODEL: model

  • QUALITY_RULE: quality rule

  • SECRECY_LEVEL: security level

  • STANDARD_ELEMENT: data standard

  • STANDARD_ELEMENT_TEMPLATE: data standard template

  • SUBJECT: theme

  • Dimension attributes of SUMMARY_DIMENSION_ATTRIBUTE: summary tables

  • SUMMARY_INDEX: summary table indicator attribute

  • SUMMARY_TIME: time period attribute of the SDR table

  • TABLE_MODEL: relationship model (logical model/physical model)

  • TABLE_MODEL_ATTRIBUTE: relationship model attribute (logical model/physical model)

  • TABLE_MODEL_LOGIC: logical entity

  • TABLE_TYPE: table type

  • TAG: tag

  • TIME_CONDITION: time restriction

create_by

String

Creator.

update_by

String

Person who updates the information.

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.
Table 9 ApprovalVO

Parameter

Type

Description

id

String

Application ID, which is a string

tenant_id

String

Project ID. For details about how to obtain the project ID, see the API path parameter project_id.

name_ch

String

Chinese name of a service.

name_en

String

English name of a service.

biz_id

String

Business ID, which is a string

biz_type

String

Business entity type.

Options:

  • AGGREGATION_LOGIC_TABLE: summary table

  • ATOMIC_INDEX: atomic metric

  • ATOMIC_METRIC: atomic metric (new)

  • BIZ_CATALOG: process architecture directory

  • BIZ_METRIC: service indicator

  • CODE_TABLE: code table

  • COMMON_CONDITION: general filter

  • COMPOSITE_METRIC: Compound Metric (new)

  • COMPOUND_METRIC: compound metric

  • CONDITION_GROUP: restriction group

  • DEGENERATE_DIMENSION: degenerate dimension

  • DERIVATIVE_INDEX: derivative indicator

  • DERIVED_METRIC: derivative indicator (new)

  • DIMENSION: dimension

  • DIMENSION_ATTRIBUTE: dimension attribute

  • DIMENSION_HIERARCHIES: dimension level

  • DIMENSION_LOGIC_TABLE: dimension table

  • DIMENSION_TABLE_ATTRIBUTE: dimension attribute

  • DIRECTORY: directory

  • FACT_ATTRIBUTE: fact table attribute

  • FACT_DIMENSION: fact table dimension

  • FACT_LOGIC_TABLE: fact table

  • FACT_MEASURE: fact table measurement

  • FUNCTION: function

  • INFO_ARCH: information architecture (used for modifying themes in batches)

  • MODEL: model

  • QUALITY_RULE: quality rule

  • SECRECY_LEVEL: security level

  • STANDARD_ELEMENT: data standard

  • STANDARD_ELEMENT_TEMPLATE: data standard template

  • SUBJECT: theme

  • Dimension attributes of SUMMARY_DIMENSION_ATTRIBUTE: summary tables

  • SUMMARY_INDEX: summary table indicator attribute

  • SUMMARY_TIME: time period attribute of the SDR table

  • TABLE_MODEL: relationship model (logical model/physical model)

  • TABLE_MODEL_ATTRIBUTE: relationship model attribute (logical model/physical model)

  • TABLE_MODEL_LOGIC: logical entity

  • TABLE_TYPE: table type

  • TAG: tag

  • TIME_CONDITION: time restriction

biz_info

String

Serialized service details. The type is string.

biz_info_obj

Object

Service details. The type is object.

biz_version

Integer

Service version.

biz_status

String

Release status of an entity. This parameter is read-only and does not need to be set during creation and update.

Options:

  • DRAFT: draft

  • PUBLISH_DEVELOPING: to be reviewed

  • PUBLISHED: released

  • OFFLINE_DEVELOPING: to be reviewed

  • OFFLINE: offline

  • REJECT: rejected

approval_status

String

Service approval status. This parameter is read-only.

Options:

  • DEVELOPING: being reviewed

  • APPROVED: approved

  • REJECT: rejected

  • WITHDREW: approval cancellation

approval_type

String

Service review type.

Options:

  • PUBLISH: released

  • OFFLINE: offline

submit_time

String

Submitted At

create_by

String

Creator.

l1

String

Chinese name of the subject area group. This parameter is read-only and does not need to be set when you create or update a subject area group.

l2

String

Chinese name of the subject area. This parameter is read-only and does not need to be set during creation and update.

l3

String

Chinese name of the business object. This parameter is read-only and does not need to be set during creation and update.

approval_time

String

Review time.

approver

String

Reviewer.

email

String

Email address of the reviewer.

msg

String

Review information.

directory_path

String

Directory tree.
Table 10 TableModelAttributeVO

Parameter

Type

Description

id

String

ID, which is a string

name_en

String

Field name.

name_ch

String

Service attribute.

description

String

Description.

obs_location

String

OBS path, which is a subpath.

create_by

String

Creator.

update_by

String

Person who updates the information.

data_type

String

Field type

domain_type

String

Domain to which a field type belongs.

Options:

  • NUMBER: number

  • STRING: character type

  • DATETIME: date type

  • BLOB: large object (BLOB)

  • OTHER: other types

data_type_extend

String

Extended field of the data type.

is_primary_key

Boolean

Indicates whether a key is a primary key.

is_partition_key

Boolean

Indicates whether the key is a partition key.

is_foreign_key

Boolean

Indicates whether a key is a foreign key.

extend_field

Boolean

Indicates whether an attribute is inherited.

not_null

Boolean

Indicates whether the value is empty.

ordinal

Integer

Sequence number.

table_model_id

String

ID of the relational model, which is a string

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

tags

Array of TagVO objects

Read-only table tags

secrecy_levels

Array of SecrecyLevelVO objects

Confidentiality

stand_row_id

String

ID of the associated data standard, which is a string

stand_row_name

String

Name of the associated data standard. This parameter is read-only.

quality_infos

Array of QualityInfoVO objects

Quality information, which is read-only.

alias

String

Alias

self_defined_fields

Array of SelfDefinedFieldVO objects

User-defined item.

code

String

Logical Attribute Code

related_logic_attr_id

String

ID of the associated logical attribute, which is a string

related_logic_attr_name

String

Chinese name of an associated logical entity attribute.

related_logic_attr_name_en

String

English name of an associated logical entity attribute.
Table 11 TagVO

Parameter

Type

Description

id

String

ID, which is a string

name

String

Label name

description

String

Description.

create_by

String

Creator.

update_by

String

Person who updates the information.

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

new_biz

BizVersionManageVO object

Service version management. This parameter is read-only.
Table 12 SecrecyLevelVO

Parameter

Type

Description

id

String

Security level ID, which is a string

uuid

String

Data security primary key.

name

String

Confidentiality name.

slevel

Integer

Confidentiality level.

description

String

Confidentiality description.

create_by

String

Creator.

update_by

String

Person who updates the information.

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

new_biz

BizVersionManageVO object

Service version management. This parameter is read-only.
Table 13 BizVersionManageVO

Parameter

Type

Description

id

String

Field ID, which is a string

biz_type

String

Business entity type.

Options:

  • AGGREGATION_LOGIC_TABLE: summary table

  • ATOMIC_INDEX: atomic metric

  • ATOMIC_METRIC: atomic metric (new)

  • BIZ_CATALOG: process architecture directory

  • BIZ_METRIC: service indicator

  • CODE_TABLE: code table

  • COMMON_CONDITION: general filter

  • COMPOSITE_METRIC: Compound Metric (new)

  • COMPOUND_METRIC: compound metric

  • CONDITION_GROUP: restriction group

  • DEGENERATE_DIMENSION: degenerate dimension

  • DERIVATIVE_INDEX: derivative indicator

  • DERIVED_METRIC: derivative indicator (new)

  • DIMENSION: dimension

  • DIMENSION_ATTRIBUTE: dimension attribute

  • DIMENSION_HIERARCHIES: dimension level

  • DIMENSION_LOGIC_TABLE: dimension table

  • DIMENSION_TABLE_ATTRIBUTE: dimension attribute

  • DIRECTORY: directory

  • FACT_ATTRIBUTE: fact table attribute

  • FACT_DIMENSION: fact table dimension

  • FACT_LOGIC_TABLE: fact table

  • FACT_MEASURE: fact table measurement

  • FUNCTION: function

  • INFO_ARCH: information architecture (used for modifying themes in batches)

  • MODEL: model

  • QUALITY_RULE: quality rule

  • SECRECY_LEVEL: security level

  • STANDARD_ELEMENT: data standard

  • STANDARD_ELEMENT_TEMPLATE: data standard template

  • SUBJECT: theme

  • Dimension attributes of SUMMARY_DIMENSION_ATTRIBUTE: summary tables

  • SUMMARY_INDEX: summary table indicator attribute

  • SUMMARY_TIME: time period attribute of the SDR table

  • TABLE_MODEL: relationship model (logical model/physical model)

  • TABLE_MODEL_ATTRIBUTE: relationship model attribute (logical model/physical model)

  • TABLE_MODEL_LOGIC: logical entity

  • TABLE_TYPE: table type

  • TAG: tag

  • TIME_CONDITION: time restriction

biz_id

String

Business ID, which is a string

biz_info

String

Business object information.

status

String

Release status of an entity. This parameter is read-only and does not need to be set during creation and update.

Options:

  • DRAFT: draft

  • PUBLISH_DEVELOPING: to be reviewed

  • PUBLISHED: released

  • OFFLINE_DEVELOPING: to be reviewed

  • OFFLINE: offline

  • REJECT: rejected

biz_version

Integer

Service version, which is read-only.

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.
Table 14 QualityInfoVO

Parameter

Type

Description

id

String

ID, which is a string

table_id

String

Table ID, which is a read-only string

attr_id

String

Attribute ID, which is a read-only string

biz_type

String

Business entity type.

Options:

  • AGGREGATION_LOGIC_TABLE: summary table

  • ATOMIC_INDEX: atomic metric

  • ATOMIC_METRIC: atomic metric (new)

  • BIZ_CATALOG: process architecture directory

  • BIZ_METRIC: service indicator

  • CODE_TABLE: code table

  • COMMON_CONDITION: general filter

  • COMPOSITE_METRIC: Compound Metric (new)

  • COMPOUND_METRIC: compound metric

  • CONDITION_GROUP: restriction group

  • DEGENERATE_DIMENSION: degenerate dimension

  • DERIVATIVE_INDEX: derivative indicator

  • DERIVED_METRIC: derivative indicator (new)

  • DIMENSION: dimension

  • DIMENSION_ATTRIBUTE: dimension attribute

  • DIMENSION_HIERARCHIES: dimension level

  • DIMENSION_LOGIC_TABLE: dimension table

  • DIMENSION_TABLE_ATTRIBUTE: dimension attribute

  • DIRECTORY: directory

  • FACT_ATTRIBUTE: fact table attribute

  • FACT_DIMENSION: fact table dimension

  • FACT_LOGIC_TABLE: fact table

  • FACT_MEASURE: fact table measurement

  • FUNCTION: function

  • INFO_ARCH: information architecture (used for modifying themes in batches)

  • MODEL: model

  • QUALITY_RULE: quality rule

  • SECRECY_LEVEL: security level

  • STANDARD_ELEMENT: data standard

  • STANDARD_ELEMENT_TEMPLATE: data standard template

  • SUBJECT: theme

  • Dimension attributes of SUMMARY_DIMENSION_ATTRIBUTE: summary tables

  • SUMMARY_INDEX: summary table indicator attribute

  • SUMMARY_TIME: time period attribute of the SDR table

  • TABLE_MODEL: relationship model (logical model/physical model)

  • TABLE_MODEL_ATTRIBUTE: relationship model attribute (logical model/physical model)

  • TABLE_MODEL_LOGIC: logical entity

  • TABLE_TYPE: table type

  • TAG: tag

  • TIME_CONDITION: time restriction

data_quality_id

String

Quality ID, which is a string

show_control

Integer

Indicates whether to display the regular expression.

data_quality_name

String

Quality name.

alert_conf

String

Configure alarms.

expression

String

Regular expression configuration in regular expression-related validation rules.

extend_info

String

Indicates the extension information.

from_standard

Boolean

Indicates whether the data comes from the data standard quality configuration. This parameter is read-only.

result_description

String

Result description.

create_by

String

Creator, which is read-only.

update_by

String

Updater, which is read-only.

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.
Table 15 TableMappingVO

Parameter

Type

Description

id

String

ID, which is a string

name

String

Name.

description

String

Description.

target_table_id

String

Destination table ID, which is a string

src_model_id

String

ID of the relational model for the source table. The value is a string.

src_model_name

String

Source model name.

view_text

String

Source of the collected view. The dws view is used reversely.

target_table_name

String

Name of the destination table.

details

Array of TableMappingDetailVO objects

Details.

source_tables

Array of MappingSourceTableVO objects

Mapped table information.

source_fields

Array of MappingSourceFieldVO objects

Mapped field information.

create_time

String

Creation time. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

create_by

String

Creator.

update_by

String

Person who updates the information.
Table 16 TableMappingDetailVO

Parameter

Type

Description

id

String

ID, which is a string

mapping_id

String

Name.

target_attr_id

String

ID of the destination attribute, which is a string

target_attr_name

String

Sort by destination field.

src_table_ids

String

Source table ID.

src_table_names

Array of strings

Source table name array, which is read-only.

src_table_db_names

Array of strings

Database name array of the source table. This parameter is read-only.

src_table_model_ids

Array of strings

IDs of the relational models for the source tables. The value is a read-only string.

src_table_id_list

Array of strings

IDs of source tables. The value is a read-only string.

src_attr_ids

String

ID of a field in the source table.

src_attr_names

Array of strings

Array of field names in the source table. This parameter is read-only.

src_attr_id_list

Array of strings

IDs of the source table attributes. The value is a read-only string.

remark

String

Description.

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

create_by

String

Creator.

update_by

String

Person who updates the information.

target_attr

Object

Target attribute.
Table 17 MappingSourceTableVO

Parameter

Type

Description

table1_id

String

Table 1 ID, which is a string

table2_id

String

Table 2 ID, which is a string

table1_name

String

Name of table 1.

table2_name

String

Name of table 2.

join_type

String

Association type.

Options:

  • LEFT: left outer join

  • RIGHT: right outer join

  • INNER: inner join

  • FULL: full connection

join_fields

Array of MappingJoinFieldVO objects

on condition.
Table 18 MappingJoinFieldVO

Parameter

Type

Description

field1_id

String

Attribute 1 ID, which is a string

field2_id

String

Attribute 2 ID, which is a string

field1_name

String

Name of attribute 1.

field2_name

String

Name of attribute 2.
Table 19 MappingSourceFieldVO

Parameter

Type

Description

target_field_id

String

ID of the target field, which is a field in the current table. The ID is a string.

target_field_name

String

Target field code.

field_ids

String

Source field ID. Use commas (,) to separate multiple IDs.

transform_expression

String

Conversion expression.

field_names

Array of strings

List of source field names.

changed

Boolean

Indicates whether a field is changed.
Table 20 RelationVO

Parameter

Type

Description

id

String

ID, which is a string

source_table_id

String

Source table ID, which is a string

target_table_id

String

Destination table ID, which is a string

name

String

Relationship name.

source_table_name

String

Name of the source table.

target_table_name

String

Name of the destination table.

role

String

Role.

tenant_id

String

Tenant ID.

source_type

String

Relationship type, which is read-only.

Options:

  • ONE: Each child (parent) logical entity has only one record in the parent (child) logical entity.

  • ZERO_OR_ONE: indicates that each child (parent) logical entity data record corresponds to only one data record in the parent (child) logical entity.

  • ZERO_OR_N: indicates that each child (parent) logical entity data record may correspond to multiple data records in the parent (child) logical entity.

  • ONE_OR_N: Each child (parent) logical entity corresponds to at least one data record in the parent (child) logical entity.

target_type

String

Relationship type, which is read-only.

Options:

  • ONE: Each child (parent) logical entity has only one record in the parent (child) logical entity.

  • ZERO_OR_ONE: indicates that each child (parent) logical entity data record corresponds to only one data record in the parent (child) logical entity.

  • ZERO_OR_N: indicates that each child (parent) logical entity data record may correspond to multiple data records in the parent (child) logical entity.

  • ONE_OR_N: Each child (parent) logical entity corresponds to at least one data record in the parent (child) logical entity.

create_by

String

Creator.

update_by

String

Person who updates the information.

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

mappings

Array of RelationMappingVO objects

Table attribute information, which is read-only.
Table 21 RelationMappingVO

Parameter

Type

Description

id

String

ID, which is a string

relation_id

String

Relationship ID, which is a string

source_field_id

String

Source field ID, which is a string

target_field_id

String

Destination field ID, which is a string

source_field_name

String

Name of the source table.

target_field_name

String

Name of the destination table.

create_by

String

Creator.

update_by

String

Person who updates the information.

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.
Table 22 SelfDefinedFieldVO

Parameter

Type

Description

fd_name_ch

String

Chinese name of a user-defined item.

fd_name_en

String

English name of a customized item.

not_null

Boolean

Whether a parameter is mandatory.

fd_value

String

Attribute value

Status code: 400

Table 23 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 401

Table 24 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 403

Table 25 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Example Requests

This API is used to obtain model table details by ID.

GET https://{endpoint}/v2/{project_id}/design/table-model/1231932180633112576

Example Responses

Status code: 200

This operation is successful, and the returned data is TableModelVO details.

{
  "data" : {
    "value" : {
      "id" : "1231932180633112576",
      "model_id" : "1208730797675311104",
      "parent_table_id" : null,
      "parent_table_name" : null,
      "parent_table_code" : null,
      "related_logic_table_id" : null,
      "related_logic_table_name" : null,
      "related_logic_table_model_id" : null,
      "related_logic_table_model_name" : null,
      "model" : {
        "id" : "1208730797675311104",
        "name" : "xingneng2",
        "description" : "",
        "is_physical" : true,
        "frequent" : false,
        "top" : false,
        "level" : null,
        "dw_type" : "MRS_HIVE",
        "create_time" : "2024-02-18T11:04:39+08:00",
        "update_time" : "2024-02-18T11:04:39+08:00",
        "create_by" : "test_uesr",
        "update_by" : "test_uesr",
        "type" : "THIRD_NF",
        "biz_catalog_ids" : null,
        "databases" : null,
        "table_model_prefix" : ""
      },
      "data_format" : "Parquet",
      "obs_bucket" : null,
      "obs_location" : null,
      "configs" : "{}",
      "table_type" : "HIVE_TABLE",
      "owner" : "",
      "tb_name" : "test_update_table_model",
      "dw_id" : "0fafdd43a342436e87e42d7217d26679",
      "db_name" : null,
      "queue_name" : null,
      "schema" : null,
      "extend_info" : "{\"dirtyOutDatabase\":\"\",\"dirtyOutPrefix\":\"\",\"dirtyOutSuffix\":\"\",\"dirtyOutSwitch\":\"false\"}",
      "tb_guid" : null,
      "tb_id" : null,
      "logic_tb_name" : "test_update_table_model",
      "logic_tb_guid" : null,
      "description" : "N/A",
      "status" : "DRAFT",
      "logic_tb_id" : null,
      "biz_catalog_id" : "958408897973161984",
      "catalog_path" : "tesy",
      "create_by" : "test_uesr",
      "update_by" : "test_uesr",
      "create_time" : "2024-04-22T11:38:40+08:00",
      "update_time" : "2024-04-22T11:39:22+08:00",
      "tags" : [ ],
      "approval_info" : null,
      "new_biz" : null,
      "attributes" : [ {
        "id" : "1231932180754747392",
        "name_en" : "col_a",
        "name_ch" : "col_a",
        "description" : "",
        "obs_location" : null,
        "create_by" : null,
        "update_by" : null,
        "data_type" : "STRING",
        "domain_type" : "STRING",
        "data_type_extend" : "",
        "is_primary_key" : false,
        "is_partition_key" : false,
        "is_foreign_key" : false,
        "extend_field" : false,
        "not_null" : false,
        "ordinal" : 1,
        "table_model_id" : null,
        "create_time" : "2024-04-22T11:38:40+08:00",
        "update_time" : "2024-04-22T11:39:23+08:00",
        "tags" : [ ],
        "secrecy_levels" : [ ],
        "stand_row_id" : null,
        "stand_row_name" : null,
        "quality_infos" : [ ],
        "alias" : "",
        "self_defined_fields" : [ {
          "fd_name_ch" : "Sue",
          "fd_name_en" : "SDSDFD",
          "not_null" : false,
          "fd_value" : ""
        }, {
          "fd_name_ch" : "test",
          "fd_name_en" : "test",
          "not_null" : false,
          "fd_value" : ""
        } ],
        "code" : "",
        "related_logic_attr_id" : null,
        "related_logic_attr_name" : null,
        "related_logic_attr_name_en" : null
      }, {
        "id" : "1231932180754747393",
        "name_en" : "col_b",
        "name_ch" : "col_b",
        "description" : "",
        "obs_location" : null,
        "create_by" : null,
        "update_by" : null,
        "data_type" : "STRING",
        "domain_type" : "STRING",
        "data_type_extend" : "",
        "is_primary_key" : false,
        "is_partition_key" : false,
        "is_foreign_key" : false,
        "extend_field" : false,
        "not_null" : false,
        "ordinal" : 2,
        "table_model_id" : null,
        "create_time" : "2024-04-22T11:38:40+08:00",
        "update_time" : "2024-04-22T11:39:23+08:00",
        "tags" : [ ],
        "secrecy_levels" : [ ],
        "stand_row_id" : null,
        "stand_row_name" : null,
        "quality_infos" : [ ],
        "alias" : "",
        "self_defined_fields" : [ {
          "fd_name_ch" : "Sue",
          "fd_name_en" : "SDSDFD",
          "not_null" : false,
          "fd_value" : ""
        }, {
          "fd_name_ch" : "test",
          "fd_name_en" : "test",
          "not_null" : false,
          "fd_value" : ""
        } ],
        "code" : "",
        "related_logic_attr_id" : null,
        "related_logic_attr_name" : null,
        "related_logic_attr_name_en" : null
      } ],
      "mappings" : null,
      "relations" : [ ],
      "dw_type" : "MRS_HIVE",
      "dw_name" : "MRS_Hive",
      "l1" : "tesy",
      "l2" : null,
      "l3" : null,
      "l1_id" : "958408897973161984",
      "l2_id" : null,
      "l3_id" : null,
      "partition_conf" : null,
      "dlf_task_id" : null,
      "use_recently_partition" : false,
      "reversed" : null,
      "dirty_out_switch" : false,
      "dirty_out_database" : "",
      "dirty_out_prefix" : "",
      "dirty_out_suffix" : "",
      "quality_owner" : null,
      "quality_id" : null,
      "distribute" : null,
      "distribute_column" : null,
      "is_partition" : false,
      "physical_table" : "NO_NEED",
      "dev_physical_table" : "NO_NEED",
      "technical_asset" : "NO_NEED",
      "business_asset" : "NO_NEED",
      "meta_data_link" : "NO_NEED",
      "data_quality" : "NO_NEED",
      "summary_status" : "NO_NEED",
      "dev_version" : null,
      "prod_version" : null,
      "dev_version_name" : null,
      "prod_version_name" : null,
      "env_type" : "INVALID_TYPE",
      "alias" : null,
      "self_defined_fields" : null,
      "code" : null,
      "has_related_physical_table" : false,
      "has_related_logic_table" : false
    }
  }
}

Status code: 400

BadRequest

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user request is illegal."
}

Status code: 401

Unauthorized

{
  "error_code" : "DS.60xx",
  "error_msg" : "User authentication failed."
}

Status code: 403

Forbidden

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user does not have permission to call this API."
}

Status Codes

Status Code

Description

200

This operation is successful, and the returned data is TableModelVO details.

400

BadRequest

401

Unauthorized

403

Forbidden
Parent Topic: ER Modeling