Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Dimension Tables/ Viewing Dimension Table Details

Updated on 2025-11-17 GMT+08:00

View PDF

Viewing Dimension Table Details

Function

This API is used to view details about a dimension table by ID.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/design/dimension-logic-tables/{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	DimensionLogicTableVO object	value: unified outer data structure of the returned result.

**Table 6** DimensionLogicTableVO
Parameter	Type	Description
id	String	Table ID
tb_name	String	Table name
tb_logic_name	String	Name of a logical entity.
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 string
create_by	String	Creator.
description	String	Description.
dimension_id	String	Dimension ID, which is a string
owner	String	Asset owner.
dimension_type	String	Dimension type. Options: COMMON: common dimension LOOKUP: code table dimension HIERARCHIES: hierarchy dimension
code_table_id	String	Referenced lookup table ID (mandatory for creating or updating a lookup table dimension). The value is a string.
code_table	CodeTableVO object	Reference lookup table, which is read-only.
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.
dw_id	String	Data connection ID.
reversed	Boolean	Indicates whether it is reverse.
partition_conf	String	Partition expression.
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.
db_name	String	Database name.
tb_id	String	Data table ID. This parameter is read-only.
schema	String	Required by the DWS type.
table_type	String	Table type
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
tb_guid	String	GUID of the created data catalog technology asset after the table is released. This parameter is read-only and does not need to be set during creation and update.
tb_logic_guid	String	GUID of the created data catalog service asset after the table is released. This parameter is read-only and does not need to be set during creation and update.
dimension_name	String	Associated dimension name, which is read-only.
attributes	Array of DimensionLogicTableAttributeVO objects	Field attribute.
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.
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.
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.
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
materialization	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
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.
quality_id	String	Quality ID, which is a string
alias	String	Alias
self_defined_fields	Array of SelfDefinedFieldVO objects	User-defined item.
obs_location	String	Foreign Table Path
configs	String	Other Configurations
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
model_id	String	Model ID, which is a string
model	WorkspaceVO object	Model information

**Table 7** CodeTableVO
Parameter	Type	Description
id	String	Lookup table ID, which is a string
name_en	String	Table name, in English.
name_ch	String	Table name, in Chinese.
tb_version	Integer	Table version.
directory_id	String	Directory ID, which is a string
directory_path	String	Directory tree.
description	String	Description.
create_by	String	Creator.
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
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.
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.
code_table_fields	Array of CodeTableFieldVO objects	Code list attribute information.

**Table 8** CodeTableFieldVO
Parameter	Type	Description
id	String	Lookup table field ID, which is a string
code_table_id	String	ID of the lookup table (mandatory for update), which is a string
ordinal	Integer	Sequence number.
name_en	String	Field name, in English.
name_ch	String	Field name, in Chinese.
description	String	Description.
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_unique_key	Boolean	Whether the field is unique.
code_table_field_values	Array of CodeTableFieldValueVO objects	Code list attribute value.
count_field_values	Integer	Total number of lookup table attribute values.

**Table 9** CodeTableFieldValueVO
Parameter	Type	Description
id	String	Lookup table field ID, which is a string
fd_id	String	Attribute ID of the lookup table, which is a string
fd_value	String	Code list attribute value.
ordinal	Integer	Sequence number.
description	String	Description.

**Table 10** DimensionLogicTableAttributeVO
Parameter	Type	Description
id	String	Dimension table ID, which is a string
dimension_logic_table_id	String	ID of the dimension table.
ordinal	Integer	No.
dimension_attribute_id	String	Dimension attribute ID, which is a string
name_en	String	Field name, which is read-only.
name_ch	String	Service attribute. This parameter is read-only.
description	String	Description, which is read-only.
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. This parameter is read-only.
is_biz_primary	Boolean	Indicates whether it is a service primary key.
is_partition_key	Boolean	Indicates whether the partition is a primary key partition. This parameter is read-only.
not_null	Boolean	Indicates whether the value is empty.
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.
secrecy_levels	Array of SecrecyLevelVO objects	Confidentiality

**Table 11** 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 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** 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 14** 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 15** 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

**Table 16** 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.

Status code: 400

**Table 17** 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 18** 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 19** 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 view details about a dimension table by ID.

GET https://{endpoint}/v2/{project_id}/design/dimension-logic-tables/1222930979413499904

Example Responses

Status code: 200

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

{
  "data" : {
    "value" : {
      "id" : "1222930979413499904",
      "tb_name" : "dim_test_czh_0328",
      "tb_logic_name" : "test_czh_0328",
      "l1_id" : "1194966710038474752",
      "l2_id" : null,
      "l3_id" : null,
      "create_by" : "test_uesr",
      "description" : "N/A",
      "dimension_id" : "1222930977286987776",
      "owner" : "afcaca",
      "dimension_type" : "COMMON",
      "code_table_id" : null,
      "code_table" : null,
      "queue_name" : "default",
      "dw_id" : "8259af52bd294f98920ebce75a426391",
      "reversed" : null,
      "partition_conf" : null,
      "dirty_out_switch" : false,
      "dirty_out_database" : "",
      "dirty_out_prefix" : "",
      "dirty_out_suffix" : "",
      "db_name" : "bi",
      "tb_id" : null,
      "schema" : "",
      "table_type" : "MANAGED",
      "status" : "PUBLISHED",
      "tb_guid" : null,
      "tb_logic_guid" : "712edcdd-3bba-4077-b182-4a1f17e5bcd8",
      "dimension_name" : "test_czh_0328",
      "attributes" : [ {
        "id" : "1222930979442860032",
        "dimension_logic_table_id" : "1222930979413499904",
        "ordinal" : 1,
        "dimension_attribute_id" : "1222930977370873856",
        "name_en" : "dim_test_czh_0328_key",
        "name_ch" : "test_czh_0328",
        "description" : "",
        "data_type" : "BIGINT",
        "domain_type" : "NUMBER",
        "data_type_extend" : null,
        "is_primary_key" : true,
        "is_biz_primary" : false,
        "is_partition_key" : false,
        "not_null" : false,
        "stand_row_id" : null,
        "stand_row_name" : null,
        "quality_infos" : [ ],
        "alias" : "",
        "self_defined_fields" : [ {
          "fd_name_ch" : "aa",
          "fd_name_en" : "aa",
          "not_null" : false,
          "fd_value" : ""
        }, {
          "fd_name_ch" : "bb",
          "fd_name_en" : "bb",
          "not_null" : false,
          "fd_value" : ""
        } ],
        "secrecy_levels" : [ ]
      }, {
        "id" : "1222930979442860033",
        "dimension_logic_table_id" : "1222930979413499904",
        "ordinal" : 2,
        "dimension_attribute_id" : "1222930977370873857",
        "name_en" : "aaa",
        "name_ch" : "aaa",
        "description" : "",
        "data_type" : "BIGINT",
        "domain_type" : "NUMBER",
        "data_type_extend" : null,
        "is_primary_key" : false,
        "is_biz_primary" : false,
        "is_partition_key" : false,
        "not_null" : false,
        "stand_row_id" : null,
        "stand_row_name" : null,
        "quality_infos" : [ ],
        "alias" : "",
        "self_defined_fields" : [ {
          "fd_name_ch" : "aa",
          "fd_name_en" : "aa",
          "not_null" : false,
          "fd_value" : ""
        }, {
          "fd_name_ch" : "bb",
          "fd_name_en" : "bb",
          "not_null" : false,
          "fd_value" : ""
        } ],
        "secrecy_levels" : [ ]
      }, {
        "id" : "1222930979442860034",
        "dimension_logic_table_id" : "1222930979413499904",
        "ordinal" : 3,
        "dimension_attribute_id" : "1222930977370873858",
        "name_en" : "bbb",
        "name_ch" : "bbb",
        "description" : "",
        "data_type" : "BIGINT",
        "domain_type" : "NUMBER",
        "data_type_extend" : null,
        "is_primary_key" : false,
        "is_biz_primary" : false,
        "is_partition_key" : false,
        "not_null" : false,
        "stand_row_id" : null,
        "stand_row_name" : null,
        "quality_infos" : [ ],
        "alias" : "",
        "self_defined_fields" : [ {
          "fd_name_ch" : "aa",
          "fd_name_en" : "aa",
          "not_null" : false,
          "fd_value" : ""
        }, {
          "fd_name_ch" : "bb",
          "fd_name_en" : "bb",
          "not_null" : false,
          "fd_value" : ""
        } ],
        "secrecy_levels" : [ ]
      } ],
      "dw_type" : "DWS",
      "dw_name" : "dws",
      "l1" : "test_czh_catalog",
      "l2" : null,
      "l3" : null,
      "create_time" : "2024-03-28T15:31:06+08:00",
      "update_time" : "2024-03-28T15:31:10+08:00",
      "approval_info" : null,
      "new_biz" : null,
      "physical_table" : "CREATE_FAILED",
      "dev_physical_table" : "NO_NEED",
      "technical_asset" : "CREATE_FAILED",
      "business_asset" : "CREATE_SUCCESS",
      "meta_data_link" : "UPDATE_FAILED",
      "data_quality" : "NO_NEED",
      "materialization" : null,
      "summary_status" : "SUMMARY_FAILED",
      "distribute" : null,
      "distribute_column" : null,
      "obs_location" : null,
      "quality_id" : null,
      "alias" : "",
      "configs" : "{}",
      "self_defined_fields" : [ {
        "fd_name_ch" : "User-defined item 1",
        "fd_name_en" : "selfDefine1",
        "not_null" : false,
        "fd_value" : ""
      }, {
        "fd_name_ch" : "User-defined item 2",
        "fd_name_en" : "selfDefine2",
        "not_null" : true,
        "fd_value" : "adada"
      } ],
      "dev_version" : null,
      "prod_version" : null,
      "dev_version_name" : null,
      "prod_version_name" : null,
      "env_type" : "PROD_TYPE"
    }
  }
}

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 DimensionLogicTableVO details.
400	BadRequest
401	Unauthorized
403	Forbidden

Parent Topic: Dimension Tables

Previous topic: Deleting Dimension Tables

Next topic: Fact Tables

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel