Creating a Data Standard
Function
Create a data standard.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/design/standards
|
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
|
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. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
values |
Yes |
Array of StandElementValueVO objects |
Attributes |
|
id |
No |
String |
Data standard ID, which is a string |
|
directory_id |
Yes |
String |
ID of the directory to which the standard belongs. The value is a string. |
|
directory_path |
No |
String |
Directory tree. |
|
row_id |
No |
String |
Row ID, 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:
|
|
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. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
fd_name |
Yes |
String |
Attribute name. |
|
fd_value |
No |
String |
Property value. |
|
fd_id |
No |
String |
Attribute ID, which is a string |
|
directory_id |
No |
String |
ID of the directory to which the standard belongs. The value is a string. |
|
row_id |
No |
String |
ID of the row to which the standard belongs. The value is a string. |
|
id |
No |
String |
Data standard ID, 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:
|
|
create_by |
No |
String |
Creator. |
|
update_by |
No |
String |
Person who updates the information. |
|
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:
|
|
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:
|
|
approval_status |
No |
String |
Service approval status. This parameter is read-only. Options:
|
|
approval_type |
No |
String |
Service review type. Options:
|
|
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. |
|
|
No |
String |
Email address of the reviewer. |
|
msg |
No |
String |
Review information. |
|
directory_path |
No |
String |
Directory tree. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
No |
String |
Field ID, which is a string |
|
biz_type |
No |
String |
Business entity type. Options:
|
|
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:
|
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
data |
data object |
The data result is returned when the data standard is created. |
|
Parameter |
Type |
Description |
|---|---|---|
|
values |
Array of StandElementValueVO objects |
Attributes |
|
id |
String |
Data standard ID, which is a string |
|
directory_id |
String |
ID of the directory to which the standard belongs. The value is a string. |
|
directory_path |
String |
Directory tree. |
|
row_id |
String |
Row ID, which is a string |
|
status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
|
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. |
|
Parameter |
Type |
Description |
|---|---|---|
|
fd_name |
String |
Attribute name. |
|
fd_value |
String |
Property value. |
|
fd_id |
String |
Attribute ID, which is a string |
|
directory_id |
String |
ID of the directory to which the standard belongs. The value is a string. |
|
row_id |
String |
ID of the row to which the standard belongs. The value is a string. |
|
id |
String |
Data standard ID, which is a string |
|
status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
|
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. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Application ID, which is a string |
|
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 |
Business ID, which is a string |
|
biz_type |
String |
Business entity type. Options:
|
|
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:
|
|
approval_status |
String |
Service approval status. This parameter is read-only. Options:
|
|
approval_type |
String |
Service review type. Options:
|
|
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. |
|
|
String |
Email address of the reviewer. |
|
msg |
String |
Review information. |
|
directory_path |
String |
Directory tree. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Field ID, which is a string |
|
biz_type |
String |
Business entity type. Options:
|
|
biz_id |
String |
Business ID, which is a string |
|
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:
|
|
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
|
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
|
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
|
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
|
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" : "test_uesr",
"update_by" : "test_uesr",
"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" : "test_uesr",
"update_by" : "test_uesr",
"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" : "test_uesr",
"update_by" : "test_uesr",
"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" : "test_uesr",
"update_by" : "test_uesr",
"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" : "test_uesr",
"update_by" : "test_uesr",
"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" : "test_uesr",
"update_by" : "test_uesr",
"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" : "test_uesr",
"update_by" : "test_uesr",
"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" : "test_uesr",
"update_by" : "test_uesr",
"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" : "test_uesr",
"update_by" : "test_uesr",
"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" : "test_uesr",
"update_by" : "test_uesr",
"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" : "test_uesr",
"update_by" : "test_uesr",
"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" : "test_uesr",
"update_by" : "test_uesr",
"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" : "test_uesr",
"update_by" : "test_uesr",
"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" : "test_uesr",
"update_by" : "test_uesr",
"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" : "test_uesr",
"update_by" : "test_uesr",
"create_time" : "2024-04-11T20:51:18.893+08:00",
"update_time" : "2024-04-11T20:51:18.893+08:00"
}
}
}
Status code: 400
BadRequest
{
"error_code" : "DS.60xx",
"error_msg" : "The user request is illegal."
}
Status code: 401
Unauthorized
{
"error_code" : "DS.60xx",
"error_msg" : "User authentication failed."
}
Status code: 403
Forbidden
{
"error_code" : "DS.60xx",
"error_msg" : "The user does not have permission to call this API."
}
Status code: 404
Not Found
{
"error_code" : "DS.60xx",
"error_msg" : "The User Request API does not exist."
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Success |
|
400 |
BadRequest |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.