Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Overview/ Standard Coverage Statistics
Updated on 2025-11-17 GMT+08:00
View PDF

Standard Coverage Statistics

Function

View the coverage of a data standard in all model fields, that is, the percentage of fields that use the standard to the total fields.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/design/definitions/statistic/{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

biz_type

No

String

Query by service type. The options are ATOMIC_INDEX (atomic indicator), DERIVATIVE_INDEX (derivative indicator), DIMENSION (dimension), and TIME_CONDITION (time filter). DIMENSION_LOGIC_TABLE (dimension table), FACT_LOGIC_TABLE (fact table), AGGREGATION_LOGIC_TABLE (summary table), TABLE_MODEL (relational modeling table), CODE_TABLE (code table), STANDARD_ELEMENT) (data standard), BIZ_METRIC (business metric), COMPOUND_METRIC (compound metric), SUBJECT (subject), ATOMIC_METRIC (atomic metric (new)), DERIVED_METRIC (Derivative (new)), COMPOSITE_METRIC (Compound (new))).

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

StatisticStandardCoverageVO object

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

Parameter

Type

Description

all_col_num

String

Total number of fields, which is a string

col_num

String

Number of associated standard fields, which is a string

coverage

Double

Standard coverage.

details

Array of AllTableVO objects

Array of reference tables.
Table 7 AllTableVO

Parameter

Type

Description

id

String

L1 ID, which is a string

name

String

L1 name.

tb_logic_guid

String

GUID of the logical entity after the table is released.

quality_id

String

Quality 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.

tb_guid

String

GUID of the physical table after the table is released.

code

String

Code.

create_by

String

Creator.

tenant_id

String

Tenant ID.

description

String

Description.

status

String

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

Options:

  • DRAFT: draft

  • PUBLISH_DEVELOPING: to be reviewed

  • PUBLISHED: released

  • OFFLINE_DEVELOPING: to be reviewed

  • OFFLINE: offline

  • REJECT: rejected

biz_type

String

Business entity type.

Options:

  • AGGREGATION_LOGIC_TABLE: summary table

  • ATOMIC_INDEX: atomic metric

  • ATOMIC_METRIC: atomic metric (new)

  • BIZ_CATALOG: process architecture directory

  • BIZ_METRIC: service indicator

  • CODE_TABLE: code table

  • COMMON_CONDITION: general filter

  • COMPOSITE_METRIC: Compound Metric (new)

  • COMPOUND_METRIC: compound metric

  • CONDITION_GROUP: restriction group

  • DEGENERATE_DIMENSION: degenerate dimension

  • DERIVATIVE_INDEX: derivative indicator

  • DERIVED_METRIC: derivative indicator (new)

  • DIMENSION: dimension

  • DIMENSION_ATTRIBUTE: dimension attribute

  • DIMENSION_HIERARCHIES: dimension level

  • DIMENSION_LOGIC_TABLE: dimension table

  • DIMENSION_TABLE_ATTRIBUTE: dimension attribute

  • DIRECTORY: directory

  • FACT_ATTRIBUTE: fact table attribute

  • FACT_DIMENSION: fact table dimension

  • FACT_LOGIC_TABLE: fact table

  • FACT_MEASURE: fact table measurement

  • FUNCTION: function

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

  • MODEL: model

  • QUALITY_RULE: quality rule

  • SECRECY_LEVEL: security level

  • STANDARD_ELEMENT: data standard

  • STANDARD_ELEMENT_TEMPLATE: data standard template

  • SUBJECT: theme

  • Dimension attributes of SUMMARY_DIMENSION_ATTRIBUTE: summary tables

  • SUMMARY_INDEX: summary table indicator attribute

  • SUMMARY_TIME: time period attribute of the SDR table

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

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

  • TABLE_MODEL_LOGIC: logical entity

  • TABLE_TYPE: table type

  • TAG: tag

  • TIME_CONDITION: time restriction

create_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.

db_name

String

Indicates the database name.

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.

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.

l1

String

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

l2

String

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

l3

String

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

l1_id

String

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

l2_id

String

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

l3_id

String

Business object ID, which is a read-only string

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

dlf_task

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

publish_to_dlm

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

standard_count

String

Standard quantity, which is a read-only string

alias

String

Alias

api_id

String

API ID of the SDR table.

workspace_id

String

Workspace ID

workspace_name

String

Workspace name

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
Table 8 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.

Status code: 400

Table 9 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 10 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 11 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

View the table attribute coverage of the data standard whose ID is 1186622399320305665.

GET https://{endpoint}/v2/{project_id}/design/definitions/statistic/1186622399320305665?biz_type=STANDARD_ELEMENT

Example Responses

Status code: 200

This operation succeeds, and the returned data is StatisticStandardCoverageVO.

{
  "data" : {
    "value" : {
      "all_col_num" : "621",
      "col_num" : "1",
      "coverage" : 0.001610305958132045,
      "details" : [ {
        "id" : "1202300665725100032",
        "name" : "test_czh_secrecy_0055",
        "tb_logic_guid" : "163b03fa-44c8-4eb1-9844-fdec203325b0",
        "quality_id" : null,
        "reversed" : null,
        "partition_conf" : null,
        "dirty_out_switch" : false,
        "dirty_out_database" : "",
        "dirty_out_prefix" : "",
        "dirty_out_suffix" : "",
        "tb_guid" : null,
        "code" : "test_czh_secrecy_005",
        "create_by" : "test_uesr",
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
        "description" : "None",
        "status" : "PUBLISHED",
        "biz_type" : "TABLE_MODEL",
        "create_time" : "2024-01-31T17:13:36+08:00",
        "update_time" : "2024-04-08T15:50:39+08:00",
        "db_name" : null,
        "dw_type" : "DWS",
        "queue_name" : null,
        "schema" : null,
        "l1" : null,
        "l2" : null,
        "l3" : null,
        "l1_id" : null,
        "l2_id" : null,
        "l3_id" : "1194966710038474752",
        "new_biz" : null,
        "physical_table" : "UPDATE_FAILED",
        "dev_physical_table" : "NO_NEED",
        "technical_asset" : "CREATE_FAILED",
        "business_asset" : "NO_NEED",
        "meta_data_link" : "UPDATE_FAILED",
        "data_quality" : "NO_NEED",
        "dlf_task" : "NO_NEED",
        "materialization" : null,
        "publish_to_dlm" : null,
        "summary_status" : "SUMMARY_FAILED",
        "standard_count" : "1",
        "alias" : null,
        "api_id" : "0",
        "workspace_id" : "9ce2cfd08fda4f3b95faa5ba65fa5ec3",
        "workspace_name" : "test_czh_simple",
        "dev_version" : null,
        "prod_version" : "1202300758293389312",
        "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 succeeds, and the returned data is StatisticStandardCoverageVO.

400

BadRequest

401

Unauthorized

403

Forbidden
Parent Topic: Overview