Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Business Metrics/ Querying Service Indicator Information
Updated on 2025-11-17 GMT+08:00
View PDF

Querying Service Indicator Information

Function

Search for service indicator information by name, creator, and modification time.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/design/biz-metrics

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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

name

No

String

Fuzzy query by name or code.

create_by

No

String

Query by creator.

owner

No

String

Query by owner.

status

No

String

Specifies the service status.

Options:

  • DRAFT: draft

  • PUBLISH_DEVELOPING: to be approved

  • PUBLISHED: released

  • OFFLINE_DEVELOPING: to be approved

  • OFFLINE: offline

  • REJECT: rejected

sync_status

No

String

Defines the enumeration of the synchronization status.

Options:

  • RUNNING: synchronizing

  • NO_NEED: not synchronized

  • SUMMARY_SUCCESS: overall success

  • SUMMARY_FAILED: overall failure

sync_key

No

Array of strings

Defines the enumeration of synchronization task types.

Options:

  • BUSINESS_ASSET: synchronizes service assets.

  • DATA_QUALITY: Create a quality job.

  • TECHNICAL_ASSET: synchronizes technology assets.

  • META_DATA_LINK: asset association

  • PHYSICAL_TABLE: Create a table (production environment).

  • DEV_PHYSICAL_TABLE: Create a table in the development environment.

  • DLF_TASK: creates a data development job.

  • MATERIALIZATION: Data is stored in the database (code table).

  • PUBLISH_TO_DLM: publishes data service APIs.

  • SUMMARY_STATUS: overall status

biz_catalog_id

No

String

ID of the service catalog to which the belongs.

begin_time

No

String

Left boundary of time filtering. This parameter is used together with end_time. Only time range filtering is supported. Unilateral filtering is invalid. 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.

end_time

No

String

Right boundary for time filtering. This parameter is used together with begin_time to support only time range filtering. 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.

limit

No

Integer

Number of records to be queried on each page, that is, Y records to be queried. The default value is 50, and the value range is [1,100].

offset

No

Integer

Start coordinate of the query, that is, the number of skipped data records. The value can only be 0 or an integer multiple of limit. If the value does not meet the requirement, the value is rounded down. The default value is 0.

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

value object

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

Parameter

Type

Description

total

Integer

Total number.

records

Array of BizMetricVO objects

BizMetricVO information.
Table 7 BizMetricVO

Parameter

Type

Description

id

String

ID, which is a string. This parameter is mandatory for update and is left empty for creation.

name

String

Metric name.

code

String

Indicator code, which is read-only.

name_alias

String

Indicates the indicator alias.

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

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_catalog_id

String

ID of the business architecture, which is a string

biz_catalog_path

String

Path of the process architecture to which the process belongs. This parameter is read-only.

create_by

String

Creator, which is read-only.

update_by

String

Updater, which is read-only.

data_origin

String

Data source.

unit

String

Metering unit.

time_filters

String

Statistical period (time limit).

dimensions

String

Statistical dimension.

general_filters

String

Statistical caliber and modifiers.

interval_type

String

Refresh frequency.

The options are as follows:

  • MINUTE: every minute

  • HOUR: hourly

  • DAY: daily

  • WEEK: weekly

  • MONTH: monthly

  • YEAR: yearly

  • REAL_TIME: real-time

  • HALF_HOUR: every half an hour

  • QUART: quarterly

  • DOUBLE_WEEK: every two weeks

  • HALF_YEAR: every half a year

  • HALF_DAY: every half a day

apply_scenario

String

Application scenarios

technical_metric

String

Associated technical metric, which is an ID string

technical_metric_name

String

Name of the associated technical indicator. This parameter is read-only.

technical_metric_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

measure

String

Measurement object.

owner

String

Indicator owner.

owner_department

String

Indicator management department.

destination

String

Set the purpose.

guid

String

GUID after asset synchronization. This parameter is read-only.

definition

String

Indicator definition.

expression

String

Indicates the calculation formula.

remark

String

Description.

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.

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.

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.

biz_metric

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

self_defined_fields

Array of SelfDefinedFieldVO objects

Custom Fields
Table 8 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 9 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 10 SelfDefinedFieldVO

Parameter

Type

Description

fd_name_ch

String

Chinese name of a user-defined item.

fd_name_en

String

English name of a customized item.

not_null

Boolean

Whether a parameter is mandatory.

fd_value

String

Attribute value

Status code: 400

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

Status code: 401

Table 12 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 13 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 query the first 10 service indicator data records and return the service indicator set.

GET https://{endpoint}/v2/{project_id}/design/biz-metrics?offset=1&limit=10

Example Responses

Status code: 200

This operation succeeds, and the returned data is a BizMetricVO array and the total number of records.

{
  "data" : {
    "value" : {
      "total" : 1,
      "records" : [ {
        "id" : "1193199235202428928",
        "name" : "test_czh_001",
        "code" : "ZB000000",
        "name_alias" : null,
        "biz_type" : null,
        "status" : "PUBLISHED",
        "biz_catalog_id" : "1193122318579281920",
        "biz_catalog_path" : "test_czh_001",
        "create_by" : "test_uesr",
        "update_by" : "test_uesr",
        "data_origin" : null,
        "unit" : null,
        "time_filters" : "Day",
        "dimensions" : "",
        "general_filters" : null,
        "interval_type" : "MONTH",
        "apply_scenario" : null,
        "technical_metric" : null,
        "technical_metric_name" : null,
        "technical_metric_type" : null,
        "measure" : null,
        "owner" : "test_uesr",
        "owner_department" : "sss",
        "destination" : "Test",
        "guid" : "ead2dc91-e81d-4590-94e3-5f7f69dd85b5",
        "definition" : "There is no special meaning.",
        "expression" : "Helen Keller formula",
        "remark" : null,
        "approval_info" : {
          "id" : "1193199265908928512",
          "tenant_id" : null,
          "name_ch" : null,
          "name_en" : null,
          "biz_id" : "1193199235202428928",
          "biz_type" : null,
          "biz_info" : null,
          "biz_info_obj" : null,
          "biz_version" : 0,
          "biz_status" : "PUBLISHED",
          "approval_status" : "APPROVED",
          "approval_type" : null,
          "submit_time" : "2024-01-06T14:27:54+08:00",
          "create_by" : null,
          "l1" : null,
          "l2" : null,
          "l3" : null,
          "approval_time" : "2024-01-15T20:27:37+08:00",
          "approver" : "test_uesr",
          "email" : null,
          "msg" : "1",
          "directory_path" : null
        },
        "new_biz" : null,
        "create_time" : "2024-01-06T14:27:46+08:00",
        "update_time" : "2024-01-15T20:27:37+08:00",
        "l1" : "test_czh_001",
        "l2" : null,
        "l3" : null,
        "biz_metric" : "CREATE_SUCCESS",
        "summary_status" : "SUMMARY_SUCCESS",
        "self_defined_fields" : null
      } ]
    }
  }
}

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 a BizMetricVO array and the total number of records.

400

BadRequest

401

Unauthorized

403

Forbidden
Parent Topic: Business Metrics