Updated on 2022-09-15 GMT+08:00

Modifying a Data Standard

Function

This API is used to modify a data standard.

URI

PUT /v2/{project_id}/design/standards/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

id

Yes

String

Entity ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

values

Yes

Array of StandElementValueVO objects

Values

id

No

Long

ID

directory_id

Yes

Long

ID of the directory where the standard is located

directory_path

No

String

Catalog tree

row_id

No

Long

ID of the row where the standard is located

status

No

String

Business statuses

Enumeration values:

  • DRAFT

  • PUBLISH_DEVELOPING

  • PUBLISHED

  • OFFLINE_DEVELOPING

  • OFFLINE

  • REJECT

approval_info

No

ApprovalVO object

Approval information

new_biz

No

BizVersionManageVO object

Business version management

create_by

No

String

Creator

update_by

No

String

User who updated the standard

create_time

No

String

Creation time

update_time

No

String

Update time

Table 3 StandElementValueVO

Parameter

Mandatory

Type

Description

fd_name

Yes

String

Field name

fd_value

No

String

Field value

fd_id

No

Long

Field ID

directory_id

No

Long

ID of the directory where the standard is located

row_id

No

Long

ID of the row where the standard is located

id

No

Long

ID

status

No

String

Business statuses

Enumeration values:

  • DRAFT

  • PUBLISH_DEVELOPING

  • PUBLISHED

  • OFFLINE_DEVELOPING

  • OFFLINE

  • REJECT

create_by

No

String

Creator

update_by

No

String

User who updated the standard

create_time

No

String

Creation time

update_time

No

String

Update time

Table 4 ApprovalVO

Parameter

Mandatory

Type

Description

id

No

Long

ID

tenant_id

No

String

tenant id

name_ch

No

String

Approval name in Chinese

name_en

No

String

Approval name in English

biz_id

No

Long

Business ID

biz_type

No

String

Business types

Enumeration values:

  • ATOMIC_INDEX

  • DERIVATIVE_INDEX

  • DIMENSION

  • DIMENSION_ATTRIBUTE

  • DIMENSION_HIERARCHIES

  • CONDITION_GROUP

  • TIME_CONDITION

  • COMMON_CONDITION

  • FACT_LOGIC_TABLE

  • TABLE_MODEL

  • DIMENSION_LOGIC_TABLE

  • STANDARD_ELEMENT

  • AGGREGATION_LOGIC_TABLE

  • TAG

  • CODE_TABLE

  • TABLE_MODEL_ATTRIBUTE

  • FACT_DIMENSION

  • FACT_ATTRIBUTE

  • FACT_MEASURE

  • SUMMARY_DIMENSION_ATTRIBUTE

  • SUMMARY_TIME

  • DIMENSION_TABLE_ATTRIBUTE

  • QUALITY_RULE

  • BIZ_METRIC

  • COMPOUND_METRIC

  • INFO_ARCH

  • DEGENERATE_DIMENSION

  • TABLE_MODEL_LOGIC

biz_info

No

String

Business information

biz_info_obj

No

Object

Business information object

biz_version

No

Integer

Business version

biz_status

No

String

Business statuses

Enumeration values:

  • DRAFT

  • PUBLISH_DEVELOPING

  • PUBLISHED

  • OFFLINE_DEVELOPING

  • OFFLINE

  • REJECT

approval_status

No

String

Approval statuses

Enumeration values:

  • DEVELOPING

  • APPROVED

  • REJECT

  • WITHDREW

approval_type

No

String

Approval types

Enumeration values:

  • PUBLISH

  • OFFLINE

submit_time

No

String

Submission time

create_by

No

String

Creator

l1

No

String

Subject area group

l2

No

String

Subject area

l3

No

String

Business object

approval_time

No

String

Approval time

approver

No

String

Approver

email

No

String

Approver email address

msg

No

String

Approval message

directory_path

No

String

Directory tree

Table 5 BizVersionManageVO

Parameter

Mandatory

Type

Description

id

No

Long

ID information

biz_type

No

String

Business types

Enumeration values:

  • ATOMIC_INDEX

  • DERIVATIVE_INDEX

  • DIMENSION

  • DIMENSION_ATTRIBUTE

  • DIMENSION_HIERARCHIES

  • CONDITION_GROUP

  • TIME_CONDITION

  • COMMON_CONDITION

  • FACT_LOGIC_TABLE

  • TABLE_MODEL

  • DIMENSION_LOGIC_TABLE

  • STANDARD_ELEMENT

  • AGGREGATION_LOGIC_TABLE

  • TAG

  • CODE_TABLE

  • TABLE_MODEL_ATTRIBUTE

  • FACT_DIMENSION

  • FACT_ATTRIBUTE

  • FACT_MEASURE

  • SUMMARY_DIMENSION_ATTRIBUTE

  • SUMMARY_TIME

  • DIMENSION_TABLE_ATTRIBUTE

  • QUALITY_RULE

  • BIZ_METRIC

  • COMPOUND_METRIC

  • INFO_ARCH

  • DEGENERATE_DIMENSION

  • TABLE_MODEL_LOGIC

biz_id

No

Long

Business ID

biz_info

No

String

Business object information

status

No

String

Business statuses

Enumeration values:

  • DRAFT

  • PUBLISH_DEVELOPING

  • PUBLISHED

  • OFFLINE_DEVELOPING

  • OFFLINE

  • REJECT

biz_version

No

Integer

Business version

create_time

No

String

Creation time

update_time

No

String

Update time

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

values

Array of StandElementValueVO objects

Values

id

Long

ID

directory_id

Long

ID of the directory where the standard is located

directory_path

String

Catalog tree

row_id

Long

ID of the row where the standard is located

status

String

Business statuses

Enumeration values:

  • DRAFT

  • PUBLISH_DEVELOPING

  • PUBLISHED

  • OFFLINE_DEVELOPING

  • OFFLINE

  • REJECT

approval_info

ApprovalVO object

Approval information

new_biz

BizVersionManageVO object

Business version management

create_by

String

Creator

update_by

String

User who updated the standard

create_time

String

Creation time

update_time

String

Update time

Table 7 StandElementValueVO

Parameter

Type

Description

fd_name

String

Field name

fd_value

String

Field value

fd_id

Long

Field ID

directory_id

Long

ID of the directory where the standard is located

row_id

Long

ID of the row where the standard is located

id

Long

ID

status

String

Business statuses

Enumeration values:

  • DRAFT

  • PUBLISH_DEVELOPING

  • PUBLISHED

  • OFFLINE_DEVELOPING

  • OFFLINE

  • REJECT

create_by

String

Creator

update_by

String

User who updated the standard

create_time

String

Creation time

update_time

String

Update time

Table 8 ApprovalVO

Parameter

Type

Description

id

Long

ID

tenant_id

String

tenant id

name_ch

String

Approval name in Chinese

name_en

String

Approval name in English

biz_id

Long

Business ID

biz_type

String

Business types

Enumeration values:

  • ATOMIC_INDEX

  • DERIVATIVE_INDEX

  • DIMENSION

  • DIMENSION_ATTRIBUTE

  • DIMENSION_HIERARCHIES

  • CONDITION_GROUP

  • TIME_CONDITION

  • COMMON_CONDITION

  • FACT_LOGIC_TABLE

  • TABLE_MODEL

  • DIMENSION_LOGIC_TABLE

  • STANDARD_ELEMENT

  • AGGREGATION_LOGIC_TABLE

  • TAG

  • CODE_TABLE

  • TABLE_MODEL_ATTRIBUTE

  • FACT_DIMENSION

  • FACT_ATTRIBUTE

  • FACT_MEASURE

  • SUMMARY_DIMENSION_ATTRIBUTE

  • SUMMARY_TIME

  • DIMENSION_TABLE_ATTRIBUTE

  • QUALITY_RULE

  • BIZ_METRIC

  • COMPOUND_METRIC

  • INFO_ARCH

  • DEGENERATE_DIMENSION

  • TABLE_MODEL_LOGIC

biz_info

String

Business information

biz_info_obj

Object

Business information object

biz_version

Integer

Business version

biz_status

String

Business statuses

Enumeration values:

  • DRAFT

  • PUBLISH_DEVELOPING

  • PUBLISHED

  • OFFLINE_DEVELOPING

  • OFFLINE

  • REJECT

approval_status

String

Approval statuses

Enumeration values:

  • DEVELOPING

  • APPROVED

  • REJECT

  • WITHDREW

approval_type

String

Approval types

Enumeration values:

  • PUBLISH

  • OFFLINE

submit_time

String

Submission time

create_by

String

Creator

l1

String

Subject area group

l2

String

Subject area

l3

String

Business object

approval_time

String

Approval time

approver

String

Approver

email

String

Approver email address

msg

String

Approval message

directory_path

String

Directory tree

Table 9 BizVersionManageVO

Parameter

Type

Description

id

Long

ID information

biz_type

String

Business types

Enumeration values:

  • ATOMIC_INDEX

  • DERIVATIVE_INDEX

  • DIMENSION

  • DIMENSION_ATTRIBUTE

  • DIMENSION_HIERARCHIES

  • CONDITION_GROUP

  • TIME_CONDITION

  • COMMON_CONDITION

  • FACT_LOGIC_TABLE

  • TABLE_MODEL

  • DIMENSION_LOGIC_TABLE

  • STANDARD_ELEMENT

  • AGGREGATION_LOGIC_TABLE

  • TAG

  • CODE_TABLE

  • TABLE_MODEL_ATTRIBUTE

  • FACT_DIMENSION

  • FACT_ATTRIBUTE

  • FACT_MEASURE

  • SUMMARY_DIMENSION_ATTRIBUTE

  • SUMMARY_TIME

  • DIMENSION_TABLE_ATTRIBUTE

  • QUALITY_RULE

  • BIZ_METRIC

  • COMPOUND_METRIC

  • INFO_ARCH

  • DEGENERATE_DIMENSION

  • TABLE_MODEL_LOGIC

biz_id

Long

Business ID

biz_info

String

Business object information

status

String

Business statuses

Enumeration values:

  • DRAFT

  • PUBLISH_DEVELOPING

  • PUBLISHED

  • OFFLINE_DEVELOPING

  • OFFLINE

  • REJECT

biz_version

Integer

Business version

create_time

String

Creation time

update_time

String

Update time

Status code: 400

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Status code: 401

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Status code: 403

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Status code: 404

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Example Requests

{
  "id" : 0,
  "directory_id" : "793889791589650432",
  "values" : [ {
    "fd_name" : "nameEn",
    "fd_value" : "demo"
  }, {
    "fd_name" : "dataType",
    "fd_value" : "STRING"
  }, {
    "fd_name" : "dataLength",
    "fd_value" : "128"
  }, {
    "fd_name" : "hasAllowValueList",
    "fd_value" : false
  }, {
    "fd_name" : "allowList",
    "fd_value" : ""
  }, {
    "fd_name" : "referCodeTable",
    "fd_value" : "885123958788317184"
  }, {
    "fd_name" : "codeStandColumn",
    "fd_value" : "52470"
  }, {
    "fd_name" : "dqcRule",
    "fd_value" : ""
  }, {
    "fd_name" : "ruleOwner",
    "fd_value" : "liuxu"
  }, {
    "fd_name" : "dataMonitorOwner",
    "fd_value" : "liuxu"
  }, {
    "fd_name" : "standardLevel",
    "fd_value" : "domain"
  }, {
    "fd_name" : "description",
    "fd_value" : "This is a demo."
  } ]
}

Example Responses

Status code: 200

Success

{
  "data" : {
    "value" : [ {
      "xxx" : "See the get request."
    } ]
  }
}

Status Codes

Status Code

Description

200

Success

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found