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

Updating an Atomic Metric

Function

This API is used to update a single atomic metric.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/design/atomic-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 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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

id

No

String

Code. Set this parameter to a value of the String type instead of the Long type.

name_en

Yes

String

Indicates the English name of an atomic metric.

name_ch

Yes

String

Indicates the English name of an atomic metric.

description

No

String

Description.

create_by

No

String

Creator.

cal_exp

Yes

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

No

Array of strings

ID of the referenced function. The value of this parameter is of the String type instead of the Long type.

l2_id

No

String

Subject area ID.

l3_id

Yes

String

Service object GUID. Set this parameter to a value of the String type instead of the Long type.

table_id

Yes

String

Fact table ID. Set this parameter to the string type instead of the long type.

tb_name

No

String

Name of a fact table.

field_ids

Yes

Array of strings

Field ID. The value of this parameter is of the String type instead of the Long type.

field_names

No

Array of strings

Field name.

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

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

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 ApprovalVO

Parameter

Mandatory

Type

Description

id

No

String

Application ID. The value of this parameter is of the String type instead of the Long type.

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

Service ID. The value is of the String type instead of the Long type.

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 5 BizVersionManageVO

Parameter

Mandatory

Type

Description

id

No

String

ID information. The value of this parameter is of the String type instead of the Long type.

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

Service ID. The value is of the String type instead of the Long type.

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 6 Response body parameters

Parameter

Type

Description

data

data object

Returned data.

Table 7 data

Parameter

Type

Description

value

AtomicIndexVO object

Returned data information.

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

Update atomic metrics based on the following parameters:

PUT https://{endpoint}/v2/{project_id}/design/atomic-indexs

{
  "id" : "1227990857618227200",
  "name_ch" : "test_update_atomic_index",
  "name_en" : "test_update_atomic_index",
  "table_id" : "1215358267694411776",
  "cal_exp" : "max(${1215358267774103552})",
  "l3_id" : "1080855591154495488",
  "field_ids" : [ "1215358267774103552" ],
  "biz_type" : "FACT_LOGIC_TABLE",
  "description" : "This is the description of an atomic metric."
}

Example Responses

Status code: 200

This operation succeeds, and the returned data is AtomicIndexVO.

{
  "data" : {
    "value" : {
      "id" : "1227990857618227200",
      "name_en" : "test_update_atomic_index",
      "name_ch" : "test_update_atomic_index",
      "description" : "This is the description of an atomic metric.",
      "create_by" : "ei_dayu_y00321344_01",
      "cal_exp" : "max(${1215358267774103552})",
      "cal_fn_ids" : null,
      "l1_id" : null,
      "l2_id" : null,
      "l3_id" : "1080855591154495488",
      "table_id" : "1215358267694411776",
      "tb_name" : null,
      "dw_type" : null,
      "field_ids" : [ "1215358267774103552" ],
      "field_names" : null,
      "status" : "DRAFT",
      "biz_type" : "FACT_LOGIC_TABLE",
      "create_time" : "2024-04-11T14:37:15+08:00",
      "update_time" : "2024-04-11T14:45:26.179+08:00",
      "l1" : null,
      "l2" : null,
      "l3" : null,
      "approval_info" : 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.

Update atomic metrics based on the following parameters:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
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.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateDesignAtomicIndexSolution {

    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();
        UpdateDesignAtomicIndexRequest request = new UpdateDesignAtomicIndexRequest();
        AtomicIndexVO body = new AtomicIndexVO();
        List<String> listbodyFieldIds = new ArrayList<>();
        listbodyFieldIds.add("1215358267774103552");
        body.withBizType(AtomicIndexVO.BizTypeEnum.fromValue("FACT_LOGIC_TABLE"));
        body.withFieldIds(listbodyFieldIds);
        body.withTableId("1215358267694411776");
        body.withL3Id("1080855591154495488");
        body.withCalExp("max(${1215358267774103552})");
        body.withDescription("This is the description of an atomic metric.");
        body.withNameCh("test_update_atomic_index");
        body.withNameEn("test_update_atomic_index");
        body.withId("1227990857618227200");
        request.withBody(body);
        try {
            UpdateDesignAtomicIndexResponse response = client.updateDesignAtomicIndex(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());
        }
    }
}

Update atomic metrics based on the following parameters:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# 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 = UpdateDesignAtomicIndexRequest()
        listFieldIdsbody = [
            "1215358267774103552"
        ]
        request.body = AtomicIndexVO(
            biz_type="FACT_LOGIC_TABLE",
            field_ids=listFieldIdsbody,
            table_id="1215358267694411776",
            l3_id="1080855591154495488",
            cal_exp="max(${1215358267774103552})",
            description="This is the description of an atomic metric.",
            name_ch="test_update_atomic_index",
            name_en="test_update_atomic_index",
            id="1227990857618227200"
        )
        response = client.update_design_atomic_index(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Update atomic metrics based on the following parameters:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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.UpdateDesignAtomicIndexRequest{}
	var listFieldIdsbody = []string{
        "1215358267774103552",
    }
	bizTypeBizType:= model.GetBizTypeEnumBizTypeEnum().FACT_LOGIC_TABLE
	descriptionAtomicIndexVo:= "This is the description of an atomic metric."
	idAtomicIndexVo:= "1227990857618227200"
	request.Body = &model.AtomicIndexVo{
		BizType: &bizTypeBizType,
		FieldIds: listFieldIdsbody,
		TableId: "1215358267694411776",
		L3Id: "1080855591154495488",
		CalExp: "max(${1215358267774103552})",
		Description: &descriptionAtomicIndexVo,
		NameCh: "test_update_atomic_index",
		NameEn: "test_update_atomic_index",
		Id: &idAtomicIndexVo,
	}
	response, err := client.UpdateDesignAtomicIndex(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 AtomicIndexVO.

400

BadRequest

401

Unauthorized

403

Forbidden