Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Derivative Metrics/ Creating a Derivative Metric

Updated on 2024-12-03 GMT+08:00

Online Debugging

CLI Examples

View PDF

Creating a Derivative Metric

Function

This API is used to create a derivative metric.

Calling Method

For details, see Calling APIs.

URI

POST /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.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
[items]	Yes	Array of DerivativeIndexVO objects	Request body for creating a derivative metric

**Table 3** DerivativeIndexVO
Parameter	Mandatory	Type	Description
id	No	String	Derivative metric ID, which is a string. This parameter is mandatory for update.
name_en	Yes	String	Derivative metric name in English
name_ch	Yes	String	Derivative metric name
create_by	No	String	Creator.
data_type	No	String	Field type
l2_id	No	String	Subject area ID.
l3_id	Yes	String	Business object GUID, 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
atomic_index_id	Yes	String	Atomic metric ID, which is a string
time_condition_id	No	String	Time filter ID, which is a string
time_field_id	No	String	ID of the field associated with the time filter, which is a string
common_conditions	No	Array of CommonConditionVO objects	General filter information.
dimension_groups	No	Array of DerivativeIndexDimensionVO objects	Statistical dimension, which cannot be changed during update
monitor	No	MetricMonitorVO object	Monitor metrics.
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_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.
new_biz	No	BizVersionManageVO object	Service version management. This parameter is read-only.

**Table 4** CommonConditionVO
Parameter	Mandatory	Type	Description
name	Yes	String	Name.
field_ids	Yes	Array of strings	Field ID, in the format table_id.field_id.
field_names	No	Array of strings	Field name information. Format: Table name.Field name.
cal_exp	Yes	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	Yes	Array of strings	Reference function ID, which is a string
front_configs	No	String	Frontend expression configuration, which is used for front-end data restoration.

**Table 5** DerivativeIndexDimensionVO
Parameter	Mandatory	Type	Description
group_id	Yes	String	Dimension group ID.
role	No	String	Dimension role.
dimension_id	No	String	Dimension ID, which is a string
hierarchies_id	No	String	Dimension level ID, which is a string
group_name	No	String	Name of a dimension group.
group_code	No	String	Dimension group code.
biz_type	Yes	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
l2_id	No	String	Subject area ID.
dw_type	No	String	Data connection type.

**Table 6** MetricMonitorVO
Parameter	Mandatory	Type	Description
id	No	String	ID, which is a string
other_metric_ids	No	Array of strings	ID of another metric, which is a string
other_compound_metric_ids	No	Array of strings	ID of another composite index.
expression	No	String	Alarm expression.
metric_id	No	String	Mount pointer ID, which is a string
front_configs	No	String	Frontend expression configuration, which is used for front-end data restoration.
metric_type	No	String	Type of the mounted indicator.

**Table 7** 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 8** BizVersionManageVO
Parameter	Mandatory	Type	Description
id	No	String	Field 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_id	No	String	Business ID, which is a string
biz_info	No	String	Business object information.
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

Response Parameters

Status code: 200

**Table 9** Response body parameters
Parameter	Type	Description
data	data object	Number of successfully created derivative metrics

**Table 10** data
Parameter	Type	Description
value	BatchOperationVO object	Result of creating a derivative metric

**Table 11** BatchOperationVO
Parameter	Type	Description
id	String	Batch approval ID, which is a string
tenant_id	String	Project ID.
group_id	String	Group ID, which is a string
biz_name	String	Service name.
biz_id	String	Business ID, which is a string
operation_status	String	Operation result type enumeration. RUNNING(Running), SUCCESS(Operation succeeded), and FAILED(Operation failed). Options: RUNNING: The task is running. SUCCESS: The operation is successful. FAILED: The operation fails.
operation_type	String	Indicates the type.
biz_info	String	Service details.
create_by	String	Creator.
remark	String	Indicates the remark information.
total	Integer	Total number.
success	Integer	Number of successful operations.
failed	Integer	Indicates the number of failed operations.
rate	String	Indicates the current progress.
logs	String	Logs.
groups	Array of BatchOperationVO objects	Group information.

Status code: 400

**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: 401

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

Status code: 403

**Table 14** 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 derivative metric based on request parameters.

POST https://{endpoint}/v2/{project_id}/design/derivative-indexs

[ {
  "name_ch" : "Total fare(supplier,stroke order.fare)",
  "name_en" : "sum_total_amount",
  "data_type" : "STRING",
  "l3_id" : "1169309252771299328",
  "atomic_index_id" : "1170005876631875584",
  "dimension_groups" : [ {
    "biz_type" : "DIMENSION",
    "group_id" : "1169322847009742848",
    "group_name" : "Supplier",
    "dimension_id" : "1169322847009742848",
    "role" : null,
    "hierarchies_id" : null
  }, {
    "biz_type" : "DEGENERATE_DIMENSION",
    "group_id" : "1169329693619625984.1169329693695123463",
    "group_name" : "Stroke order.fare",
    "dimension_id" : null,
    "role" : null,
    "hierarchies_id" : null
  } ],
  "time_condition_id" : null,
  "time_field_id" : null,
  "common_conditions" : [ ],
  "monitor" : null,
  "description" : ""
} ]

Example Responses

Status code: 200

The operation succeeds. BatchOperationVO is returned.

{
  "data" : {
    "value" : {
      "id" : null,
      "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
      "group_id" : "1300493983935508480",
      "biz_name" : null,
      "biz_id" : null,
      "operation_status" : "SUCCESS",
      "operation_type" : "BATCH_CREATE",
      "biz_info" : null,
      "create_by" : "test_uesr",
      "remark" : null,
      "total" : 1,
      "success" : 1,
      "failed" : 0,
      "rate" : "1.00",
      "logs" : null,
      "groups" : [ {
        "id" : "1300493984405270528",
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
        "group_id" : "1300493983935508480",
        "biz_name" : "Total fare(supplier,stroke order.fare)",
        "biz_id" : "1300493984245886976",
        "operation_status" : "SUCCESS",
        "operation_type" : "BATCH_CREATE",
        "biz_info" : "{\"atomic_index_id\":1170005876631875584,\"create_by\":\"test_uesr\",\"data_type\":\"STRING\",\"description\":\"\",\"id\":1300493984245886976,\"l3_id\":1169309252771299328,\"name_ch\": \"total fare(supplier,stroke order.fare)\",\"name_en\":\"sum_total_amount\",\"status\":\"DRAFT\"}",
        "create_by" : "test_uesr",
        "remark" : "CREATE",
        "total" : 0,
        "success" : 0,
        "failed" : 0,
        "rate" : null,
        "logs" : null,
        "groups" : 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. BatchOperationVO is returned.
400	BadRequest
401	Unauthorized
403	Forbidden

Parent Topic: Derivative Metrics

Previous topic: Searching for Derivative Indicators

Next topic: Updating a Derivative Metric

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

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

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot