Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Derivative Metrics/ Searching for Derivative Indicators

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

Online Debugging

CLI Examples

View PDF

Searching for Derivative Indicators

Function

Search for derivative metrics by name, creator, reviewer, status, modification time, and l3Id.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/design/derivative-indexs

**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.
approver	No	String	Query by reviewer.
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
dimension_id	No	String	This field is used to query dimension attributes based on the dimension ID. The value of this field is of the String type instead of the Long type.
dimension_group	No	String	Query dimension attributes based on the dimension granularity.
atomic_index_id	No	String	Query dimension attributes based on the atomic metric ID and enter the string type instead of the long type.
all_metrics	No	Boolean	Indicates whether to query compound metrics.
dw_type	No	String	Data Connection Type
l3_id	No	String	ID of the service object l3. The value of this parameter is of the String type instead of the Long type.
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	Returned data.

**Table 5** data
Parameter	Type	Description
value	value object	Returned data information.

**Table 6** value
Parameter	Type	Description
records	Array of DerivativeIndexVO objects	DerivativeIndexVO array.
total	Integer	Total number.

**Table 7** DerivativeIndexVO
Parameter	Type	Description
id	String	Code. Set this parameter to a value of the String type instead of the Long type.
name_en	String	Field name.
name_ch	String	Chinese name.
description	String	Description, which is read-only.
create_by	String	Creator.
data_type	String	Field type
l1_id	String	Subject area group ID, which is read-only. The value of this parameter is of the String type instead of the Long type.
l2_id	String	Subject area ID.
l3_id	String	Service object GUID. Set this parameter to a value of the String type instead of the Long type.
status	String	Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options: DRAFT: draft PUBLISH_DEVELOPING: to be reviewed PUBLISHED: released OFFLINE_DEVELOPING: to be reviewed OFFLINE: offline REJECT: rejected
atomic_index_id	String	Atomic metric ID. The value of this parameter is of the String type instead of the Long type.
time_condition_id	String	Time filter ID. The value of this parameter is of the String type instead of the Long type.
time_field_id	String	ID of the field associated with the time restriction. The value of this parameter is of the String type instead of the Long type.
time_field_name	String	Name of the field associated with the time filter. This parameter is read-only.
common_conditions	Array of CommonConditionVO objects	General filter information.
dimension_groups	Array of DerivativeIndexDimensionVO objects	Dimension group (granularity).
monitor	MetricMonitorVO object	Monitor metrics.
atomic_index	AtomicIndexVO object	Atomic metric information, including the name and unit. This parameter is read-only.
time_condition_name	String	Time filter name. 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.
summary_table_id	String	SDR table ID, which is read-only. Set this parameter to a string instead of a long value.
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.

**Table 8** CommonConditionVO
Parameter	Type	Description
name	String	Name.
field_ids	Array of strings	Field ID, in the format table_id.field_id.
field_names	Array of strings	Field name information. Format: Table name.Field name.
cal_exp	String	Calculation expression, for example, '${table_id.column_id} > 1', where table_id indicates the ID of the table to which the referenced field belongs and column_id indicates the ID of the referenced field.
cal_fn_ids	Array of strings	ID of the referenced function. The value of this parameter is of the String type instead of the Long type.
front_configs	String	Frontend expression configuration, which is used for front-end data restoration.
id	String	General filter ID, which is read-only. The value of this parameter is of the string type instead of the long type.

**Table 9** DerivativeIndexDimensionVO
Parameter	Type	Description
group_id	String	Dimension group ID.
role	String	Dimension role.
dimension_id	String	Dimension ID. Set this parameter to a value of the String type instead of the Long type.
hierarchies_id	String	Dimension level ID. Set this parameter to a value of the String type instead of the Long type.
ordinal	Integer	Sequence number, which is read-only.
group_name	String	Name of a dimension group.
group_code	String	Dimension group code.
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
hierarchies	Array of DimensionHierarchiesVO objects	Level attribute, which is read-only.
l1	String	Subject area group, which is read-only.
l2	String	Subject area, which is read-only.
l3	String	Service object, which is read-only.
l1_id	String	Subject area group ID, which is read-only. The value of this parameter is of the String type instead of the Long type.
l2_id	String	Subject area ID.
l3_id	String	Service object ID, which is read-only. The value of this parameter is of the String type instead of the Long type.
dw_type	String	Data connection type.
id	String	Level ID, which is read-only. The value of this parameter is of the String type instead of the Long type.

**Table 10** DimensionHierarchiesVO
Parameter	Type	Description
id	String	Code. Set this parameter to a value of the String type instead of the Long type.
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 11** HierarchiesAttrVO
Parameter	Type	Description
id	String	Code. Set this parameter to a value of the String type instead of the Long type.
hierarchies_id	String	Level ID. Set this parameter to a value of the String type instead of the Long type.
attr_id	String	Attribute ID. The value is of the String type instead of the Long type.
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. The value of this parameter is of the String type instead of the Long type.
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 12** DimensionAttributeVO
Parameter	Type	Description
id	String	Code. Set this parameter to a value of the String type instead of the Long type.
dimension_id	String	Dimension ID, which is read-only. The value of this parameter is of the String type instead of the Long type.
code_table_field_id	String	Code table attribute ID. The value of this parameter is of the String type instead of the Long type.
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. The value is of the String type instead of the Long type.
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 13** QualityInfoVO
Parameter	Type	Description
id	String	Code ID. The value of this parameter is of the String type instead of the Long type.
table_id	String	Table ID, which is read-only. Set this parameter to the string type instead of the long type.
attr_id	String	Attribute ID, which is read-only. The value of this parameter is of the String type instead of the Long type.
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. Set this parameter to a value of the String type instead of the Long type.
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 14** SecrecyLevelVO
Parameter	Type	Description
id	String	Security level ID. The value is of the String type instead of the Long type.
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 15** SelfDefinedFieldVO
Parameter	Type	Description
fd_name_ch	String	Chinese name of a user-defined item.
fd_name_en	String	English name of a customized item.
not_null	Boolean	Whether a parameter is mandatory.
fd_value	String	Attribute value

**Table 16** MetricMonitorVO
Parameter	Type	Description
id	String	Code. Set this parameter to a value of the String type instead of the Long type.
other_metric_ids	Array of strings	For other indicator IDs, set this parameter to the string type instead of the long type.
other_metric_names	Array of strings	Name of another indicator. This parameter is read-only.
other_compound_metric_ids	Array of strings	ID of another composite index.
other_compound_metric_names	Array of strings	Name of another compound metric.
expression	String	Alarm expression.
metric_id	String	Mounting ID. The value is of the String type instead of the Long type.
front_configs	String	Frontend expression configuration, which is used for front-end data restoration.
metric_type	String	Type of the mounted indicator.

**Table 17** AtomicIndexVO
Parameter	Type	Description
id	String	Code. Set this parameter to a value of the String type instead of the Long type.
name_en	String	Indicates the English name of an atomic metric.
name_ch	String	Indicates the English name of an atomic metric.
description	String	Description.
create_by	String	Creator.
cal_exp	String	Calculation expression, for example, 'sum(${fact_column_id})', where fact_column_id indicates the ID of the referenced field in the fact table.
cal_fn_ids	Array of strings	ID of the referenced function. The value of this parameter is of the String type instead of the Long type.
l1_id	String	Subject area group ID, which is read-only. The value of this parameter is of the String type instead of the Long type.
l2_id	String	Subject area ID.
l3_id	String	Service object GUID. Set this parameter to a value of the String type instead of the Long type.
table_id	String	Fact table ID. Set this parameter to the string type instead of the long type.
tb_name	String	Name of a fact table.
dw_type	String	Data connection type. This parameter is read-only.
field_ids	Array of strings	Field ID. The value of this parameter is of the String type instead of the Long type.
field_names	Array of strings	Field name.
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.
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_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.

**Table 18** ApprovalVO
Parameter	Type	Description
id	String	Application ID. The value of this parameter is of the String type instead of the Long type.
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	Service ID. The value is of the String type instead of the Long type.
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 19** BizVersionManageVO
Parameter	Type	Description
id	String	ID information. The value of this parameter is of the String type instead of the Long type.
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	Service ID. The value is of the String type instead of the Long type.
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 20** 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 21** 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 22** 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 derivative metrics in pagination mode based on request parameters.

GET https://{endpoint}/v2/{project_id}/design/derivative-indexs?page_start=1&page_size=10

Example Responses

Status code: 200

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

{
  "data" : {
    "value" : {
      "total" : 1,
      "records" : [ {
        "id" : "1181167466668310528",
        "name_en" : "sum_total_amount",
        "name_ch" : "Creating a derivative metric named total_amount_(vendor,stroke_order.dim_dropoff_date_key)",
        "description" : "",
        "create_by" : "ei_dayu_y00321344_01",
        "data_type" : "STRING",
        "l1_id" : "1170066794946420736",
        "l2_id" : null,
        "l3_id" : null,
        "status" : "PUBLISHED",
        "atomic_index_id" : "1170005876631875584",
        "time_condition_id" : null,
        "time_field_id" : null,
        "time_field_name" : null,
        "common_conditions" : [ ],
        "dimension_groups" : [ {
          "group_id" : "1169322847009742848",
          "role" : null,
          "dimension_id" : "1169322847009742848",
          "hierarchies_id" : null,
          "ordinal" : 1,
          "group_name" : "Suppliers",
          "group_code" : "dim_vendor",
          "biz_type" : "DIMENSION",
          "hierarchies" : null,
          "l1" : null,
          "l2" : null,
          "l3" : null,
          "l1_id" : null,
          "l2_id" : null,
          "l3_id" : null,
          "dw_type" : null,
          "id" : "1181167466768973824"
        } ],
        "monitor" : null,
        "atomic_index" : {
          "id" : "1170005876631875584",
          "name_en" : "sum_total_amount",
          "name_ch" : "total_amount",
          "description" : "",
          "create_by" : null,
          "cal_exp" : "sum (total fare)",
          "cal_fn_ids" : null,
          "l1_id" : null,
          "l2_id" : null,
          "l3_id" : null,
          "table_id" : "1169329693619625984",
          "tb_name" : null,
          "dw_type" : null,
          "field_ids" : [ ],
          "field_names" : null,
          "status" : "DRAFT",
          "biz_type" : "FACT_LOGIC_TABLE",
          "create_time" : "2024-04-20T16:12:42.274+08:00",
          "update_time" : "2024-04-20T16:12:42.274+08:00",
          "l1" : null,
          "l2" : null,
          "l3" : null,
          "approval_info" : null,
          "new_biz" : null
        },
        "time_condition_name" : null,
        "create_time" : "2023-12-04T09:37:49+08:00",
        "update_time" : "2023-12-04T09:37:49+08:00",
        "l1" : "test_001",
        "l2" : null,
        "l3" : null,
        "summary_table_id" : "1181167468975177728",
        "approval_info" : {
          "id" : "1181167467817549824",
          "tenant_id" : null,
          "name_ch" : null,
          "name_en" : null,
          "biz_id" : "1181167466668310528",
          "biz_type" : null,
          "biz_info" : null,
          "biz_info_obj" : null,
          "biz_version" : 0,
          "biz_status" : "PUBLISHED",
          "approval_status" : "APPROVED",
          "approval_type" : null,
          "submit_time" : "2023-12-04T09:37:49+08:00",
          "create_by" : null,
          "l1" : null,
          "l2" : null,
          "l3" : null,
          "approval_time" : "2023-12-04T09:37:49+08:00",
          "approver" : "ei_dayu_y00321344_01",
          "email" : null,
          "msg" : "Fast Approval OK.",
          "directory_path" : null
        },
        "new_biz" : 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."
}

SDK Sample Code

The SDK sample code is as follows.

      
       
         
         
           package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion;
import com.huaweicloud.sdk.dataartsstudio.v1.*;
import com.huaweicloud.sdk.dataartsstudio.v1.model.*;


public class ListDerivativeIndexesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DataArtsStudioClient client = DataArtsStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        ListDerivativeIndexesRequest request = new ListDerivativeIndexesRequest();
        try {
            ListDerivativeIndexesResponse response = client.listDerivativeIndexes(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

          

        

      
     

      
       
         
         
           # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdataartsstudio.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DataArtsStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListDerivativeIndexesRequest()
        response = client.list_derivative_indexes(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dataartsstudio.NewDataArtsStudioClient(
        dataartsstudio.DataArtsStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListDerivativeIndexesRequest{}
	response, err := client.ListDerivativeIndexes(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code	Description
200	This operation succeeds, and the returned data is a DerivativeIndexVO array and the total number of records.
400	BadRequest
401	Unauthorized
403	Forbidden