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

Creating a Data Standard

Function

Create a data standard.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/design/standards

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

values

Yes

Array of StandElementValueVO objects

Attributes

id

No

String

ID of a data standard. The value is of the String type instead of the Long type.

directory_id

Yes

String

Directory to which the standard belongs. The value is of the String type instead of the Long type.

directory_path

No

String

Directory tree.

row_id

No

String

ID of a standard line. The value is of the String type instead of the Long type.

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

from_public

No

Boolean

Indicates whether the data is from the public layer.

create_by

No

String

Creator.

update_by

No

String

Person who updates the information.

Table 4 StandElementValueVO

Parameter

Mandatory

Type

Description

fd_name

Yes

String

Attribute name.

fd_value

No

String

Property value.

fd_id

No

String

Attribute definition ID. The value is of the String type instead of the Long type.

directory_id

No

String

Directory to which the standard belongs. The value is of the String type instead of the Long type.

row_id

No

String

Standard row. The value is of the String type instead of the Long type.

id

No

String

ID of a data standard. The value is of the String type instead of the Long type.

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

create_by

No

String

Creator.

update_by

No

String

Person who updates the information.

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

Parameter

Type

Description

data

data object

The data result is returned when the data standard is created.

Table 8 data

Parameter

Type

Description

value

StandElementValueVOList object

Attribute value list.

Table 9 StandElementValueVOList

Parameter

Type

Description

values

Array of StandElementValueVO objects

Attributes

id

String

ID of a data standard. The value is of the String type instead of the Long type.

directory_id

String

Directory to which the standard belongs. The value is of the String type instead of the Long type.

directory_path

String

Directory tree.

row_id

String

ID of a standard line. The value is 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

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.

from_public

Boolean

Indicates whether the data is from the public layer.

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.

Table 10 StandElementValueVO

Parameter

Type

Description

fd_name

String

Attribute name.

fd_value

String

Property value.

fd_id

String

Attribute definition ID. The value is of the String type instead of the Long type.

directory_id

String

Directory to which the standard belongs. The value is of the String type instead of the Long type.

row_id

String

Standard row. The value is of the String type instead of the Long type.

id

String

ID of a data standard. The value is 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

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.

Table 11 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 12 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 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: 401

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.

Status code: 403

Table 15 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: 404

Table 16 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 data standard based on parameters.

POST https://{endpoint}/v2/{project_id}/design/standards

{
  "id" : 0,
  "directory_id" : "1228084836548411397",
  "values" : [ {
    "fd_name" : "nameCh",
    "fd_value" : "test_create_data_standard"
  }, {
    "fd_name" : "nameEn",
    "fd_value" : ""
  }, {
    "fd_name" : "englishName",
    "fd_value" : "test_create_data_standard"
  }, {
    "fd_name" : "dataType",
    "fd_value" : "STRING"
  }, {
    "fd_name" : "dataLength",
    "fd_value" : "1,256"
  }, {
    "fd_name" : "hasAllowValueList",
    "fd_value" : false
  }, {
    "fd_name" : "allowList",
    "fd_value" : ""
  }, {
    "fd_name" : "referCodeTable",
    "fd_value" : ""
  }, {
    "fd_name" : "codeStandColumn",
    "fd_value" : ""
  }, {
    "fd_name" : "dqcRule"
  }, {
    "fd_name" : "ruleOwner",
    "fd_value" : "zty_tess"
  }, {
    "fd_name" : "dataMonitorOwner",
    "fd_value" : "zty_tess"
  }, {
    "fd_name" : "standardLevel",
    "fd_value" : ""
  }, {
    "fd_name" : "description",
    "fd_value" : "This is a test case."
  } ]
}

Example Responses

Status code: 200

Success

{
  "data" : {
    "value" : {
      "values" : [ {
        "fd_name" : "nameCh",
        "fd_value" : "test_create_data_standard",
        "fd_id" : "1020622096960831488",
        "directory_id" : "1228084836548411397",
        "row_id" : "1228084992354222081",
        "id" : "1228084992358416384",
        "status" : "DRAFT",
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "create_time" : "2024-04-11T20:51:18.894+08:00",
        "update_time" : "2024-04-11T20:51:18.894+08:00"
      }, {
        "fd_name" : "nameEn",
        "fd_value" : "DS006001",
        "fd_id" : "1020622096985997312",
        "directory_id" : "1228084836548411397",
        "row_id" : "1228084992354222081",
        "id" : "1228084992358416385",
        "status" : "DRAFT",
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "create_time" : "2024-04-11T20:51:18.894+08:00",
        "update_time" : "2024-04-11T20:51:18.894+08:00"
      }, {
        "fd_name" : "englishName",
        "fd_value" : "test_create_data_standard",
        "fd_id" : "1185628711836360704",
        "directory_id" : "1228084836548411397",
        "row_id" : "1228084992354222081",
        "id" : "1228084992358416386",
        "status" : "DRAFT",
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "create_time" : "2024-04-11T20:51:18.894+08:00",
        "update_time" : "2024-04-11T20:51:18.894+08:00"
      }, {
        "fd_name" : "dataType",
        "fd_value" : "STRING",
        "fd_id" : "1020622097006968832",
        "directory_id" : "1228084836548411397",
        "row_id" : "1228084992354222081",
        "id" : "1228084992358416387",
        "status" : "DRAFT",
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "create_time" : "2024-04-11T20:51:18.894+08:00",
        "update_time" : "2024-04-11T20:51:18.894+08:00"
      }, {
        "fd_name" : "dataLength",
        "fd_value" : "1,256",
        "fd_id" : "1020622097032134656",
        "directory_id" : "1228084836548411397",
        "row_id" : "1228084992354222081",
        "id" : "1228084992358416388",
        "status" : "DRAFT",
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "create_time" : "2024-04-11T20:51:18.894+08:00",
        "update_time" : "2024-04-11T20:51:18.894+08:00"
      }, {
        "fd_name" : "hasAllowValueList",
        "fd_value" : "false",
        "fd_id" : "1020622097048911872",
        "directory_id" : "1228084836548411397",
        "row_id" : "1228084992354222081",
        "id" : "1228084992358416389",
        "status" : "DRAFT",
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "create_time" : "2024-04-11T20:51:18.894+08:00",
        "update_time" : "2024-04-11T20:51:18.894+08:00"
      }, {
        "fd_name" : "allowList",
        "fd_value" : "",
        "fd_id" : "1020622097065689088",
        "directory_id" : "1228084836548411397",
        "row_id" : "1228084992354222081",
        "id" : "1228084992358416390",
        "status" : "DRAFT",
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "create_time" : "2024-04-11T20:51:18.894+08:00",
        "update_time" : "2024-04-11T20:51:18.894+08:00"
      }, {
        "fd_name" : "referCodeTable",
        "fd_value" : "",
        "fd_id" : "1020622097086660608",
        "directory_id" : "1228084836548411397",
        "row_id" : "1228084992354222081",
        "id" : "1228084992358416391",
        "status" : "DRAFT",
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "create_time" : "2024-04-11T20:51:18.894+08:00",
        "update_time" : "2024-04-11T20:51:18.894+08:00"
      }, {
        "fd_name" : "codeStandColumn",
        "fd_value" : "",
        "fd_id" : "1020622097103437824",
        "directory_id" : "1228084836548411397",
        "row_id" : "1228084992354222081",
        "id" : "1228084992358416392",
        "status" : "DRAFT",
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "create_time" : "2024-04-11T20:51:18.894+08:00",
        "update_time" : "2024-04-11T20:51:18.894+08:00"
      }, {
        "fd_name" : "dqcRule",
        "fd_value" : null,
        "fd_id" : "1020622097124409344",
        "directory_id" : "1228084836548411397",
        "row_id" : "1228084992354222081",
        "id" : "1228084992358416393",
        "status" : "DRAFT",
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "create_time" : "2024-04-11T20:51:18.894+08:00",
        "update_time" : "2024-04-11T20:51:18.894+08:00"
      }, {
        "fd_name" : "ruleOwner",
        "fd_value" : "zty_tess",
        "fd_id" : "1020622097141186560",
        "directory_id" : "1228084836548411397",
        "row_id" : "1228084992354222081",
        "id" : "1228084992358416394",
        "status" : "DRAFT",
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "create_time" : "2024-04-11T20:51:18.894+08:00",
        "update_time" : "2024-04-11T20:51:18.894+08:00"
      }, {
        "fd_name" : "dataMonitorOwner",
        "fd_value" : "zty_tess",
        "fd_id" : "1020622097162158080",
        "directory_id" : "1228084836548411397",
        "row_id" : "1228084992354222081",
        "id" : "1228084992358416395",
        "status" : "DRAFT",
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "create_time" : "2024-04-11T20:51:18.894+08:00",
        "update_time" : "2024-04-11T20:51:18.894+08:00"
      }, {
        "fd_name" : "standardLevel",
        "fd_value" : "",
        "fd_id" : "1020622097178935296",
        "directory_id" : "1228084836548411397",
        "row_id" : "1228084992354222081",
        "id" : "1228084992358416396",
        "status" : "DRAFT",
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "create_time" : "2024-04-11T20:51:18.894+08:00",
        "update_time" : "2024-04-11T20:51:18.894+08:00"
      }, {
        "fd_name" : "description",
        "fd_value" : "This is a test case.",
        "fd_id" : "1020622097195712512",
        "directory_id" : "1228084836548411397",
        "row_id" : "1228084992354222081",
        "id" : "1228084992358416397",
        "status" : "DRAFT",
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "create_time" : "2024-04-11T20:51:18.894+08:00",
        "update_time" : "2024-04-11T20:51:18.894+08:00"
      } ],
      "id" : "1228084992354222081",
      "directory_id" : "1228084836548411397",
      "directory_path" : null,
      "row_id" : null,
      "status" : "DRAFT",
      "approval_info" : null,
      "new_biz" : null,
      "from_public" : false,
      "create_by" : "ei_dayu_y00321344_01",
      "update_by" : "ei_dayu_y00321344_01",
      "create_time" : "2024-04-11T20:51:18.893+08:00",
      "update_time" : "2024-04-11T20:51:18.893+08:00"
    }
  }
}

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 code: 404

{
  "error_code" : "DS.60xx",
  "error_msg" : "The User Request API does not exist."
}

SDK Sample Code

The SDK sample code is as follows.

Create a data standard based on 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
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
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 CreateStandardSolution {

    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();
        CreateStandardRequest request = new CreateStandardRequest();
        StandElementValueVOList body = new StandElementValueVOList();
        List<StandElementValueVO> listbodyValues = new ArrayList<>();
        listbodyValues.add(
            new StandElementValueVO()
                .withFdName("nameCh")
                .withFdValue("test_create_data_standard")
        );
        listbodyValues.add(
            new StandElementValueVO()
                .withFdName("nameEn")
                .withFdValue("")
        );
        listbodyValues.add(
            new StandElementValueVO()
                .withFdName("englishName")
                .withFdValue("test_create_data_standard")
        );
        listbodyValues.add(
            new StandElementValueVO()
                .withFdName("dataType")
                .withFdValue("STRING")
        );
        listbodyValues.add(
            new StandElementValueVO()
                .withFdName("dataLength")
                .withFdValue("1,256")
        );
        listbodyValues.add(
            new StandElementValueVO()
                .withFdName("hasAllowValueList")
                .withFdValue("false")
        );
        listbodyValues.add(
            new StandElementValueVO()
                .withFdName("allowList")
                .withFdValue("")
        );
        listbodyValues.add(
            new StandElementValueVO()
                .withFdName("referCodeTable")
                .withFdValue("")
        );
        listbodyValues.add(
            new StandElementValueVO()
                .withFdName("codeStandColumn")
                .withFdValue("")
        );
        listbodyValues.add(
            new StandElementValueVO()
                .withFdName("dqcRule")
        );
        listbodyValues.add(
            new StandElementValueVO()
                .withFdName("ruleOwner")
                .withFdValue("zty_tess")
        );
        listbodyValues.add(
            new StandElementValueVO()
                .withFdName("dataMonitorOwner")
                .withFdValue("zty_tess")
        );
        listbodyValues.add(
            new StandElementValueVO()
                .withFdName("standardLevel")
                .withFdValue("")
        );
        listbodyValues.add(
            new StandElementValueVO()
                .withFdName("description")
                .withFdValue("This is a test case.")
        );
        body.withDirectoryId("1228084836548411397");
        body.withId("0");
        body.withValues(listbodyValues);
        request.withBody(body);
        try {
            CreateStandardResponse response = client.createStandard(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());
        }
    }
}

Create a data standard based on 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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# 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 = CreateStandardRequest()
        listValuesbody = [
            StandElementValueVO(
                fd_name="nameCh",
                fd_value="test_create_data_standard"
            ),
            StandElementValueVO(
                fd_name="nameEn",
                fd_value=""
            ),
            StandElementValueVO(
                fd_name="englishName",
                fd_value="test_create_data_standard"
            ),
            StandElementValueVO(
                fd_name="dataType",
                fd_value="STRING"
            ),
            StandElementValueVO(
                fd_name="dataLength",
                fd_value="1,256"
            ),
            StandElementValueVO(
                fd_name="hasAllowValueList",
                fd_value="false"
            ),
            StandElementValueVO(
                fd_name="allowList",
                fd_value=""
            ),
            StandElementValueVO(
                fd_name="referCodeTable",
                fd_value=""
            ),
            StandElementValueVO(
                fd_name="codeStandColumn",
                fd_value=""
            ),
            StandElementValueVO(
                fd_name="dqcRule"
            ),
            StandElementValueVO(
                fd_name="ruleOwner",
                fd_value="zty_tess"
            ),
            StandElementValueVO(
                fd_name="dataMonitorOwner",
                fd_value="zty_tess"
            ),
            StandElementValueVO(
                fd_name="standardLevel",
                fd_value=""
            ),
            StandElementValueVO(
                fd_name="description",
                fd_value="This is a test case."
            )
        ]
        request.body = StandElementValueVOList(
            directory_id="1228084836548411397",
            id="0",
            values=listValuesbody
        )
        response = client.create_standard(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Create a data standard based on 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
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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.CreateStandardRequest{}
	fdValueValues:= "test_create_data_standard"
	fdValueValues1:= ""
	fdValueValues2:= "test_create_data_standard"
	fdValueValues3:= "STRING"
	fdValueValues4:= "1,256"
	fdValueValues5:= "false"
	fdValueValues6:= ""
	fdValueValues7:= ""
	fdValueValues8:= ""
	fdValueValues9:= "zty_tess"
	fdValueValues10:= "zty_tess"
	fdValueValues11:= ""
	fdValueValues12:= "This is a test case."
	var listValuesbody = []model.StandElementValueVo{
        {
            FdName: "nameCh",
            FdValue: &fdValueValues,
        },
        {
            FdName: "nameEn",
            FdValue: &fdValueValues1,
        },
        {
            FdName: "englishName",
            FdValue: &fdValueValues2,
        },
        {
            FdName: "dataType",
            FdValue: &fdValueValues3,
        },
        {
            FdName: "dataLength",
            FdValue: &fdValueValues4,
        },
        {
            FdName: "hasAllowValueList",
            FdValue: &fdValueValues5,
        },
        {
            FdName: "allowList",
            FdValue: &fdValueValues6,
        },
        {
            FdName: "referCodeTable",
            FdValue: &fdValueValues7,
        },
        {
            FdName: "codeStandColumn",
            FdValue: &fdValueValues8,
        },
        {
            FdName: "dqcRule",
        },
        {
            FdName: "ruleOwner",
            FdValue: &fdValueValues9,
        },
        {
            FdName: "dataMonitorOwner",
            FdValue: &fdValueValues10,
        },
        {
            FdName: "standardLevel",
            FdValue: &fdValueValues11,
        },
        {
            FdName: "description",
            FdValue: &fdValueValues12,
        },
    }
	idStandElementValueVoList:= "0"
	request.Body = &model.StandElementValueVoList{
		DirectoryId: "1228084836548411397",
		Id: &idStandElementValueVoList,
		Values: listValuesbody,
	}
	response, err := client.CreateStandard(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

Success

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found