Updated on 2024-11-22 GMT+08:00

Creating a Dimension

Function

This API is used to create a dimension.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/design/dimensions

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.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

id

No

String

ID string (It is read-only for creation and mandatory for update.)

name_en

Yes

String

Dimension name in English

dimension_type

Yes

String

Dimension type (The dimension type can be changed from a common dimension to a hierarchical dimension during an update, and cannot be changed in other scenarios.)

Enumerated values:

  • COMMON: common dimension

  • LOOKUP: lookup table dimension

  • HIERARCHIES: hierarchical dimension

name_ch

Yes

String

Dimension name

description

Yes

String

Description.

create_by

No

String

Creator.

update_by

No

String

Person who updates the information.

code_table_id

No

String

Referenced lookup table ID (mandatory for creating or updating a lookup table dimension). The value is a string.

l2_id

No

String

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

l3_id

Yes

String

Business object ID, which is a string

hierarchies

No

Array of DimensionHierarchiesVO objects

Level attribute.

status

No

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_info

No

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.

l1

No

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

No

String

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

l3

No

String

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

attributes

Yes

Array of DimensionAttributeVO objects

Dimension attribute information.

mappings

No

Array of TableMappingVO objects

Table mapping information.

datasource

Yes

BizDatasourceRelationVO object

Data source information, which is mandatory for creation or update

owner

Yes

String

Asset owner, which is mandatory for creating or updating an asset

obs_location

No

String

Foreign Table Path

table_type

No

String

Table type

distribute

No

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

No

String

DISTRIBUTE BY HASH column.

alias

No

String

Alias

self_defined_fields

No

Array of SelfDefinedFieldVO objects

User-defined item.

configs

No

String

Other Configurations

model_id

No

String

Model ID

model

No

WorkspaceVO object

Model information

Table 3 DimensionHierarchiesVO

Parameter

Mandatory

Type

Description

id

No

String

ID, which is a string

name

No

String

Level name.

attrs

No

Array of HierarchiesAttrVO objects

Attributes contained in a hierarchy.

create_by

No

String

Creator.

update_by

No

String

Person who updates the information.

Table 4 HierarchiesAttrVO

Parameter

Mandatory

Type

Description

id

No

String

ID, which is a string

hierarchies_id

No

String

Level ID, which is a string

attr_id

No

String

Attribute ID, which is a string

level

No

Integer

Indicates the layer.

attr_name_en

No

String

Referenced attribute code.

detail_attr_ids

No

Array of strings

Details attribute ID, which is a string

detail_attr_name_ens

No

Array of strings

Details attribute in English.

Table 5 ApprovalVO

Parameter

Mandatory

Type

Description

id

No

String

Application ID, which is a string

tenant_id

No

String

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

name_ch

No

String

Chinese name of a service.

name_en

No

String

English name of a service.

biz_id

No

String

Business ID, which is a string

biz_type

No

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

No

String

Serialized service details. The type is string.

biz_info_obj

No

Object

Service details. The type is object.

biz_version

No

Integer

Service version.

biz_status

No

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

No

String

Service approval status. This parameter is read-only.

Options:

  • DEVELOPING: being reviewed

  • APPROVED: approved

  • REJECT: rejected

  • WITHDREW: approval cancellation

approval_type

No

String

Service review type.

Options:

  • PUBLISH: released

  • OFFLINE: offline

submit_time

No

String

Submitted At

create_by

No

String

Creator.

l1

No

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

No

String

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

l3

No

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

No

String

Review time.

approver

No

String

Reviewer.

email

No

String

Email address of the reviewer.

msg

No

String

Review information.

directory_path

No

String

Directory tree.

Table 6 DimensionAttributeVO

Parameter

Mandatory

Type

Description

id

No

String

ID, which is a string

code_table_field_id

No

String

Lookup table attribute ID, which is a string

name_en

Yes

String

Field name.

name_ch

Yes

String

Service attribute.

description

No

String

Description.

create_by

No

String

Creator.

data_type

Yes

String

Field type

data_type_extend

No

String

Extended field of the data type.

is_primary_key

Yes

Boolean

Indicates whether a key is a primary key.

is_biz_primary

No

Boolean

Indicates whether it is a service primary key.

is_partition_key

No

Boolean

Indicates whether to partition.

ordinal

Yes

Integer

Sequence number.

not_null

No

Boolean

Indicates whether the value is empty.

stand_row_id

No

String

ID of the associated data standard, which is a string

status

No

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

alias

No

String

Alias

self_defined_fields

No

Array of SelfDefinedFieldVO objects

User-defined item.

Table 7 TableMappingVO

Parameter

Mandatory

Type

Description

id

No

String

ID, which is a string

name

Yes

String

Name.

description

No

String

Description.

target_table_id

No

String

Destination table ID, which is a string

src_model_id

No

String

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

src_model_name

No

String

Source model name.

view_text

No

String

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

target_table_name

No

String

Name of the destination table.

details

No

Array of TableMappingDetailVO objects

Details.

source_tables

No

Array of MappingSourceTableVO objects

Mapped table information.

source_fields

No

Array of MappingSourceFieldVO objects

Mapped field information.

create_time

No

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

No

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

No

String

Creator.

update_by

No

String

Person who updates the information.

Table 8 TableMappingDetailVO

Parameter

Mandatory

Type

Description

id

No

String

ID, which is a string

mapping_id

No

String

Name.

target_attr_id

No

String

ID of the destination attribute, which is a string

target_attr_name

Yes

String

Sort by destination field.

src_table_ids

No

String

Source table ID.

src_attr_ids

No

String

ID of a field in the source table.

remark

No

String

Description.

create_time

No

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

No

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

No

String

Creator.

update_by

No

String

Person who updates the information.

target_attr

No

Object

Target attribute.

Table 9 MappingSourceTableVO

Parameter

Mandatory

Type

Description

table1_id

Yes

String

Table 1 ID, which is a string

table2_id

No

String

Table 2 ID, which is a string

table1_name

Yes

String

Name of table 1.

table2_name

No

String

Name of table 2.

join_type

Yes

String

Association type.

Options:

  • LEFT: left outer join

  • RIGHT: right outer join

  • INNER: inner join

  • FULL: full connection

join_fields

Yes

Array of MappingJoinFieldVO objects

on condition.

Table 10 MappingJoinFieldVO

Parameter

Mandatory

Type

Description

field1_id

Yes

String

Attribute 1 ID, which is a string

field2_id

Yes

String

Attribute 2 ID, which is a string

field1_name

Yes

String

Name of attribute 1.

field2_name

Yes

String

Name of attribute 2.

Table 11 MappingSourceFieldVO

Parameter

Mandatory

Type

Description

target_field_id

No

String

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

target_field_name

Yes

String

Target field code.

field_ids

No

String

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

transform_expression

No

String

Conversion expression.

field_names

No

Array of strings

List of source field names.

changed

No

Boolean

Indicates whether a field is changed.

Table 12 BizDatasourceRelationVO

Parameter

Mandatory

Type

Description

id

No

String

ID, which is a string

biz_id

No

String

Business object information, which is a string

biz_type

No

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

dw_type

Yes

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_id

Yes

String

Data connection ID.

db_name

No

String

Indicates the database name.

queue_name

No

String

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

schema

No

String

Required by the DWS type.

Table 13 SelfDefinedFieldVO

Parameter

Mandatory

Type

Description

fd_name_ch

No

String

Chinese name of a user-defined item.

fd_name_en

No

String

English name of a customized item.

not_null

No

Boolean

Whether a parameter is mandatory.

fd_value

No

String

Attribute value

Table 14 WorkspaceVO

Parameter

Mandatory

Type

Description

id

No

String

ID, which is a string

name

Yes

String

Name of the workspace.

description

No

String

Description.

is_physical

No

Boolean

Indicates whether a table is a physical table.

frequent

No

Boolean

Indicates whether it is commonly used.

top

No

Boolean

Hierarchical governance.

level

No

String

Data governance layers.

Options:

  • SDI: source data layer

  • DWI: data integration layer

  • DWR: data reporting layer

  • DM: data mart layer

dw_type

No

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_by

No

String

Creator.

update_by

No

String

Person who updates the information.

type

Yes

String

Defines the workspace type enumeration.

Options:

  • THIRD_NF: relational modeling

  • DIMENSION: dimensional modeling

biz_catalog_ids

No

String

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

databases

No

Array of strings

Array of database names.

table_model_prefix

No

String

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

Response Parameters

Status code: 200

Table 15 Response body parameters

Parameter

Type

Description

data

data object

Data, which is the unified outermost data structure of the returned result

Table 16 data

Parameter

Type

Description

value

DimensionVO object

Value, which is the unified outer data structure of the returned result

Table 17 DimensionVO

Parameter

Type

Description

id

String

ID string (It is read-only for creation and mandatory for update.)

name_en

String

Dimension name in English

dimension_type

String

Dimension type (The dimension type can be changed from a common dimension to a hierarchical dimension during an update, and cannot be changed in other scenarios.)

Enumerated values:

  • COMMON: common dimension

  • LOOKUP: lookup table dimension

  • HIERARCHIES: hierarchical dimension

name_ch

String

Dimension name

description

String

Description.

create_by

String

Creator.

update_by

String

Person who updates the information.

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.

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

hierarchies

Array of DimensionHierarchiesVO objects

Level attribute.

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.

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.

attributes

Array of DimensionAttributeVO objects

Dimension attribute information.

mappings

Array of TableMappingVO objects

Table mapping information.

datasource

BizDatasourceRelationVO object

Data source information, which is mandatory for creation or update

owner

String

Asset owner, which is mandatory for creating or updating an asset

obs_location

String

Foreign Table Path

table_type

String

Table type

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.

alias

String

Alias

self_defined_fields

Array of SelfDefinedFieldVO objects

User-defined item.

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

model

WorkspaceVO object

Model information

Table 18 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 19 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 20 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 21 DimensionHierarchiesVO

Parameter

Type

Description

id

String

ID, which is a string

name

String

Level name.

attrs

Array of HierarchiesAttrVO objects

Attributes contained in a hierarchy.

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.

Table 22 HierarchiesAttrVO

Parameter

Type

Description

id

String

ID, which is a string

hierarchies_id

String

Level ID, which is a string

attr_id

String

Attribute ID, which is a string

level

Integer

Indicates the layer.

attr_name_en

String

Referenced attribute code.

attr_name_ch

String

Referenced attribute name, which is read-only.

detail_attr_ids

Array of strings

Details attribute ID, which is a string

detail_attr_name_ens

Array of strings

Details attribute in English.

detail_attr_name_chs

Array of strings

Details attribute in Chinese, which is read-only.

attr

DimensionAttributeVO object

Referenced attribute field, which is read-only.

detail_attrs

Array of DimensionAttributeVO objects

Details field, which is read-only.

Table 23 DimensionAttributeVO

Parameter

Type

Description

id

String

ID, which is a string

dimension_id

String

Dimension ID, which is a read-only string

code_table_field_id

String

Lookup table attribute ID, which is a string

name_en

String

Field name.

name_ch

String

Service attribute.

description

String

Description.

create_by

String

Creator.

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_biz_primary

Boolean

Indicates whether it is a service primary key.

is_partition_key

Boolean

Indicates whether to partition.

ordinal

Integer

Sequence number.

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.

secrecy_levels

Array of SecrecyLevelVO objects

Confidentiality

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.

alias

String

Alias

self_defined_fields

Array of SelfDefinedFieldVO objects

User-defined item.

Table 24 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 25 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 26 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 27 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 28 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 29 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 30 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 31 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 32 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 33 BizDatasourceRelationVO

Parameter

Type

Description

id

String

ID, which is a string

biz_id

String

Business object information, 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

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_id

String

Data connection ID.

dw_name

String

Data connection name, which is read-only.

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.

Table 34 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 35 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 36 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 37 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 38 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

Create a dimension based on the following parameters.

POST https://{endpoint}/v2/{project_id}/design/dimensions

{
  "id" : 0,
  "model_id" : "1255482244563357696",
  "name_ch" : "Test dimension",
  "name_en" : "dim_test_dimension",
  "alias" : "",
  "owner" : "test_user",
  "dimension_type" : "COMMON",
  "description" : "None",
  "l3_id" : "1169309252771299328",
  "attributes" : [ {
    "id" : 0,
    "name_ch" : "Test dimension_agent key",
    "name_en" : "dim_key",
    "alias" : "",
    "description" : "",
    "data_type" : "BIGINT",
    "data_type_extend" : null,
    "is_biz_primary" : false,
    "is_primary_key" : true,
    "is_partition_key" : false,
    "not_null" : false,
    "ordinal" : 1,
    "dimension_id" : 0,
    "create_by" : "string",
    "stand_row_id" : null,
    "stand_row_name" : null,
    "secrecy_levels" : null,
    "self_defined_fields" : [ ]
  }, {
    "id" : 0,
    "name_ch" : "Test dimension_attribute",
    "name_en" : "test_field",
    "alias" : "",
    "description" : "",
    "data_type" : "BIGINT",
    "data_type_extend" : null,
    "is_biz_primary" : false,
    "is_primary_key" : false,
    "is_partition_key" : false,
    "not_null" : false,
    "ordinal" : 2,
    "dimension_id" : 0,
    "create_by" : "string",
    "stand_row_id" : null,
    "stand_row_name" : null,
    "secrecy_levels" : null,
    "self_defined_fields" : [ ]
  } ],
  "datasource" : {
    "id" : 0,
    "biz_type" : "DIMENSION",
    "dw_type" : "DWS",
    "dw_id" : "8259af52bd294f98920ebce75a426391",
    "db_name" : "bi",
    "schema" : ""
  },
  "obs_location" : "",
  "configs" : "{}",
  "table_type" : "MANAGED",
  "mappings" : [ ]
}

Example Responses

Status code: 200

The operation succeeds. DimensionVO is returned.

{
  "data" : {
    "value" : {
      "id" : "1300473264673533952",
      "name_en" : "dim_test_dimension",
      "dimension_type" : "COMMON",
      "name_ch" : "Test dimension",
      "description" : "None",
      "create_by" : "test_uesr",
      "update_by" : "test_uesr",
      "code_table_id" : null,
      "code_table" : null,
      "l1_id" : null,
      "l2_id" : null,
      "l3_id" : "1169309252771299328",
      "hierarchies" : null,
      "status" : "DRAFT",
      "create_time" : "2024-10-28T14:56:27.923+08:00",
      "update_time" : "2024-10-28T14:56:27.923+08:00",
      "approval_info" : null,
      "new_biz" : null,
      "l1" : null,
      "l2" : null,
      "l3" : null,
      "attributes" : [ {
        "id" : "0",
        "dimension_id" : "0",
        "code_table_field_id" : null,
        "name_en" : "dim_key",
        "name_ch" : "Test dimension_agent key",
        "description" : "",
        "create_by" : "string",
        "data_type" : "BIGINT",
        "domain_type" : "NUMBER",
        "data_type_extend" : null,
        "is_primary_key" : true,
        "is_biz_primary" : false,
        "is_partition_key" : false,
        "ordinal" : 1,
        "not_null" : false,
        "stand_row_id" : null,
        "stand_row_name" : null,
        "quality_infos" : null,
        "secrecy_levels" : null,
        "status" : null,
        "create_time" : "2024-10-28T14:56:27.923+08:00",
        "update_time" : "2024-10-28T14:56:27.923+08:00",
        "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" : ""
        } ],
        "associated_code_table_field" : null
      }, {
        "id" : "0",
        "dimension_id" : "0",
        "code_table_field_id" : null,
        "name_en" : "test_field",
        "name_ch" : "Test dimension_attribute",
        "description" : "",
        "create_by" : "string",
        "data_type" : "BIGINT",
        "domain_type" : "NUMBER",
        "data_type_extend" : null,
        "is_primary_key" : false,
        "is_biz_primary" : false,
        "is_partition_key" : false,
        "ordinal" : 2,
        "not_null" : false,
        "stand_row_id" : null,
        "stand_row_name" : null,
        "quality_infos" : null,
        "secrecy_levels" : null,
        "status" : null,
        "create_time" : "2024-10-28T14:56:27.923+08:00",
        "update_time" : "2024-10-28T14:56:27.923+08:00",
        "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" : ""
        } ],
        "associated_code_table_field" : null
      } ],
      "mappings" : [ ],
      "datasource" : {
        "id" : "0",
        "biz_id" : null,
        "biz_type" : "DIMENSION",
        "dw_type" : "DLI",
        "dw_id" : "8259af52bd294f98920ebce75a426391",
        "dw_name" : null,
        "db_name" : "bi",
        "queue_name" : "default",
        "schema" : ""
      },
      "owner" : "test_user",
      "table_type" : "MANAGED",
      "distribute" : null,
      "distribute_column" : null,
      "compression" : null,
      "obs_location" : "",
      "pre_combine_field" : null,
      "alias" : "",
      "configs" : "{}",
      "self_defined_fields" : null,
      "dev_version" : null,
      "prod_version" : null,
      "dev_version_name" : null,
      "prod_version_name" : null,
      "env_type" : null,
      "model_id" : "1255482244563357696",
      "model" : null
    }
  }
}

Status code: 400

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

Status code: 401

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

Status code: 403

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

Status Codes

Status Code

Description

200

The operation succeeds. DimensionVO is returned.

400

BadRequest

401

Unauthorized

403

Forbidden