Creating a Data Standard
Function
This API is used to create a data standard.
URI
POST /v2/{project_id}/design/standards
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Request 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:
|
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 |
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:
|
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 |
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:
|
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:
|
approval_status |
No |
String |
Approval statuses Enumeration values:
|
approval_type |
No |
String |
Approval types Enumeration values:
|
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 |
|
No |
String |
Approver email address |
msg |
No |
String |
Approval message |
directory_path |
No |
String |
Directory tree |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
Long |
ID information |
biz_type |
No |
String |
Business types Enumeration values:
|
biz_id |
No |
Long |
Business ID |
biz_info |
No |
String |
Business object information |
status |
No |
String |
Business statuses Enumeration values:
|
biz_version |
No |
Integer |
Business version |
create_time |
No |
String |
Creation time |
update_time |
No |
String |
Update time |
Response Parameters
Status code: 200
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:
|
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 |
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:
|
create_by |
String |
Creator |
update_by |
String |
User who updated the standard |
create_time |
String |
Creation time |
update_time |
String |
Update time |
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:
|
biz_info |
String |
Business information |
biz_info_obj |
Object |
Business information object |
biz_version |
Integer |
Business version |
biz_status |
String |
Business statuses Enumeration values:
|
approval_status |
String |
Approval statuses Enumeration values:
|
approval_type |
String |
Approval types Enumeration values:
|
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 |
|
String |
Approver email address |
msg |
String |
Approval message |
directory_path |
String |
Directory tree |
Parameter |
Type |
Description |
---|---|---|
id |
Long |
ID information |
biz_type |
String |
Business types Enumeration values:
|
biz_id |
Long |
Business ID |
biz_info |
String |
Business object information |
status |
String |
Business statuses Enumeration values:
|
biz_version |
Integer |
Business version |
create_time |
String |
Creation time |
update_time |
String |
Update time |
Status code: 400
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
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
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
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 |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.