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

Obtaining Details of a Table Model

Function

This API is used to obtain the details of a table model with a specified ID.

URI

GET /v2/{project_id}/design/table-model/{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

model_id

Long

Model ID

parent_table_id

Long

Parent table ID

parent_table_name

String

Parent table name

parent_table_code

String

Parent table code

model

WorkspaceVO object

Model

data_format

String

Data format

Maximum: 100

obs_bucket

String

OBS bucket

Maximum: 200

obs_location

String

OBS path

Maximum: 2000

configs

String

Other configurations

Maximum: 2000

table_type

String

Table type

owner

String

Maximum: 600

tb_name

String

Table name

Maximum: 400

dw_id

String

Data connection ID

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

extend_info

String

Extended information

tb_guid

String

GUID of the materialized table

tb_id

String

Data table ID

logic_tb_name

String

Logical entity name

Maximum: 200

logic_tb_guid

String

Logical entity GUID

description

String

Description

Maximum: 200

status

String

Business statuses

Enumeration values:

  • DRAFT

  • PUBLISH_DEVELOPING

  • PUBLISHED

  • OFFLINE_DEVELOPING

  • OFFLINE

  • REJECT

logic_tb_id

Long

Logical entity ID

biz_catalog_id

Long

Business catalog ID

catalog_path

String

Catalog path. The value can be l1Id, l2Id, or l3Id.

create_by

String

Creator

update_by

String

User who updated the table model

create_time

String

Creation time

update_time

String

Update time

tags

Array of TagVO objects

Table tags

approval_info

ApprovalVO object

Approval information

new_biz

BizVersionManageVO object

Business version management

attributes

Array of TableModelAttributeVO objects

Table model attributes

mappings

Array of TableMappingVO objects

Table model mappings

relations

Array of RelationVO objects

Relationships

dw_type

String

Data connection type

dw_name

String

Data connection name

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

l1_id

Long

Subject area group ID

l2_id

String

Subject area ID

l3_id

Long

Business object ID

partition_conf

String

Partition expression

dlf_task_id

String

Data development job ID

use_recently_partition

Boolean

Whether to use the latest partition

Default: false

reversed

Boolean

Whether the table model is reversed

Default: false

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 the table with dirty data

dirty_out_suffix

String

Suffix of the table with dirty data

quality_owner

String

Quality owner

quality_id

Long

Quality ID

distribute

String

DISTRIBUTE BY [HASH(column)|REPLICATION]

Enumeration values:

  • HASH

  • REPLICATION

distribute_column

String

DISTRIBUTE BY HASH column

is_partition

Boolean

Whether the table is a partitioned table

Default: false

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

summary_status

String

Overall synchronization status

Enumeration values:

  • NO_NEED

  • CREATE_SUCCESS

  • CREATE_FAILED

  • UPDATE_SUCCESS

  • UPDATE_FAILED

  • SUMMARY_SUCCESS

  • SUMMARY_FAILED

  • RUNNING

  • OFFLINE

alias

String

Alias

self_defined_fields

Array of SelfDefinedFieldVO objects

Custom fields

Table 4 WorkspaceVO

Parameter

Type

Description

id

Long

ID

name

String

Workspace name

Maximum: 250

description

String

Maximum: 600

is_physical

Boolean

Whether the table is a physical table

Default: true

frequent

Boolean

Whether the workspace is frequently used

Default: true

top

Boolean

Hierarchical governance

Default: true

level

String

Data governance level

Enumeration values:

  • SDI

  • DWI

  • DWR

  • DM

dw_type

String

Data connection type

create_time

String

Creation time

update_time

String

Update time

create_by

String

Creator

update_by

String

User who updated the workspace

type

String

Workspace types

Enumeration values:

  • THIRD_NF

  • DIMENSION

biz_catalog_ids

String

IDs of business catalogs, including l1Ids, l2Ids, and l3Ids

databases

Array of strings

Array of database names

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 TableModelAttributeVO

Parameter

Type

Description

id

Long

ID

name_en

String

Table model attribute name in English

Maximum: 600

name_ch

String

Table model attribute name in Chinese

Maximum: 200

description

String

Maximum: 600

obs_location

String

OBS path and subpath

Maximum: 600

create_by

String

Creator

update_by

String

User who updated the table model attribute

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_partition_key

Boolean

Whether the attribute is a partition key

Default: false

is_foreign_key

Boolean

Whether the attribute is a foreign key

Default: false

extend_field

Boolean

Whether the attribute is an inherited attribute

Default: false

not_null

Boolean

Whether the attribute is not null

Default: false

ordinal

Integer

Ordinal

table_model_id

Long

Table model ID

create_time

String

Creation time

update_time

String

Update time

tags

Array of TagVO objects

Table tags

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

self_defined_fields

Array of SelfDefinedFieldVO objects

Custom fields

Table 8 TagVO

Parameter

Type

Description

id

Long

ID

name

String

Tag name

Maximum: 250

description

String

Maximum: 600

create_by

String

Creator

update_by

String

User who updated the tag

create_time

String

Creation time

update_time

String

Update time

new_biz

BizVersionManageVO object

Business version management

Table 9 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 10 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 11 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 12 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 13 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 14 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 15 RelationVO

Parameter

Type

Description

id

Long

ID

source_table_id

Long

Source table ID

target_table_id

Long

Destination table ID

name

String

Relationship name

source_table_name

String

Source table name

target_table_name

String

Destination table name

role

String

Role

tenant_id

String

Tenant ID

source_type

String

Relationship type

Enumeration values:

  • ONE

  • ZERO_OR_ONE

  • ZERO_OR_N

  • ONE_OR_N

target_type

String

Relationship type

Enumeration values:

  • ONE

  • ZERO_OR_ONE

  • ZERO_OR_N

  • ONE_OR_N

create_by

String

Creator

update_by

String

User who updated the relationship

create_time

String

Creation time

update_time

String

Update time

mappings

Array of RelationMappingVO objects

Relationship mappings

Table 16 RelationMappingVO

Parameter

Type

Description

id

Long

ID

relation_id

Long

Relationship ID

source_field_id

Long

Source field ID

target_field_id

Long

Destination field ID

source_field_name

String

Source field name

target_field_name

String

Destination field name

create_by

String

Creator

update_by

String

User who updated the mapping

create_time

String

Creation time

update_time

String

Update time

Table 17 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 18 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 19 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 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

Example Requests

None

Example Responses

Status code: 200

The operation succeeds. TableModelVO is returned.

{
  "id" : "1012314146584301568",
  "model_id" : "873242752312385536",
  "parent_table_id" : null,
  "parent_table_name" : null,
  "parent_table_code" : null,
  "model" : null,
  "data_format" : "Parquet",
  "obs_bucket" : null,
  "obs_location" : null,
  "configs" : "{}",
  "table_type" : "MANAGED",
  "owner" : "",
  "tb_name" : "staff_info",
  "dw_id" : "2c9080f07b03db8d017b198a4a20002f",
  "db_name" : "ctz_test",
  "queue_name" : "default",
  "schema" : "",
  "extend_info" : "{\"dirtyOutDatabase\":\"\",\"dirtyOutPrefix\":\"\",\"dirtyOutSuffix\":\"\",\"dirtyOutSwitch\":\"false\"}",
  "tb_guid" : null,
  "tb_id" : "NativeTable-2c9080f07b03db8d017b198a4a20002f-ctz_test-staff_info",
  "logic_tb_name" : "staff_info",
  "logic_tb_guid" : "1ab1a58b-9412-4901-bb80-4ccaaa0580e4",
  "description" : "None",
  "status" : "PUBLISHED",
  "logic_tb_id" : null,
  "biz_catalog_id" : "1012306178602041344",
  "catalog_path" : "Factory/Personnel management/Personnel archive",
  "create_by" : "abc",
  "update_by" : "abc",
  "create_time" : "2022-08-25T10:55:00+08:00",
  "update_time" : "2022-08-25T10:55:45+08:00",
  "tags" : [ ],
  "approval_info" : {
    "id" : "1012314318533988352",
    "tenant_id" : null,
    "name_ch" : null,
    "name_en" : null,
    "biz_id" : "1012314146584301568",
    "biz_type" : null,
    "biz_info" : null,
    "biz_info_obj" : null,
    "biz_version" : 0,
    "biz_status" : "PUBLISHED",
    "approval_status" : "APPROVED",
    "approval_type" : null,
    "submit_time" : "2022-08-25T10:55:41+08:00",
    "create_by" : null,
    "l1" : null,
    "l2" : null,
    "l3" : null,
    "approval_time" : "2022-08-25T10:55:41+08:00",
    "approver" : "abc",
    "email" : null,
    "msg" : "Fast Approval OK.",
    "directory_path" : null
  },
  "new_biz" : null,
  "attributes" : [ {
    "id" : "1012314146626244608",
    "name_en" : "id",
    "name_ch" : "Primary key",
    "description" : "",
    "obs_location" : null,
    "create_by" : "abc",
    "update_by" : "abc",
    "data_type" : "STRING",
    "domain_type" : "STRING",
    "data_type_extend" : "",
    "is_primary_key" : true,
    "is_partition_key" : false,
    "is_foreign_key" : false,
    "extend_field" : false,
    "not_null" : true,
    "ordinal" : 1,
    "table_model_id" : null,
    "create_time" : "2022-08-25T10:55:00+08:00",
    "update_time" : "2022-08-25T10:55:00+08:00",
    "tags" : [ ],
    "stand_row_id" : null,
    "stand_row_name" : null,
    "quality_infos" : null,
    "alias" : "",
    "self_defined_fields" : [ ]
  }, {
    "id" : "1012314146626244609",
    "name_en" : "name",
    "name_ch" : "Name",
    "description" : "",
    "obs_location" : null,
    "create_by" : "abc",
    "update_by" : "abc",
    "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" : "2022-08-25T10:55:00+08:00",
    "update_time" : "2022-08-25T10:55:00+08:00",
    "tags" : [ ],
    "stand_row_id" : null,
    "stand_row_name" : null,
    "quality_infos" : null,
    "alias" : "",
    "self_defined_fields" : [ ]
  }, {
    "id" : "1012314146592690176",
    "name_en" : "age",
    "name_ch" : "Age",
    "description" : "",
    "obs_location" : null,
    "create_by" : "abc",
    "update_by" : "abc",
    "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" : 3,
    "table_model_id" : null,
    "create_time" : "2022-08-25T10:55:00+08:00",
    "update_time" : "2022-08-25T10:55:00+08:00",
    "tags" : [ ],
    "stand_row_id" : null,
    "stand_row_name" : null,
    "quality_infos" : null,
    "alias" : "",
    "self_defined_fields" : [ ]
  } ],
  "mappings" : null,
  "relations" : [ ],
  "dw_type" : "DLI",
  "dw_name" : null,
  "l1" : "Factory",
  "l2" : "Personnel management",
  "l3" : "Personnel archive",
  "l1_id" : "1012305751919689728",
  "l2_id" : "1012306048792526848",
  "l3_id" : "1012306178602041344",
  "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" : "1012314332484304897",
  "distribute" : null,
  "distribute_column" : null,
  "is_partition" : false,
  "physical_table" : "CREATE_SUCCESS",
  "technical_asset" : "CREATE_FAILED",
  "business_asset" : "UPDATE_SUCCESS",
  "meta_data_link" : "UPDATE_FAILED",
  "data_quality" : "CREATE_SUCCESS",
  "summary_status" : "SUMMARY_FAILED",
  "alias" : null,
  "self_defined_fields" : null
}

Status Codes

Status Code

Description

200

The operation succeeds. TableModelVO is returned.

400

BadRequest

401

Unauthorized

403

Forbidden