Modifying a Data Standard Template
Function
This API is used to modify a data standard template.
URI
PUT /v2/{project_id}/design/standards/templates
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
fd_name |
Yes |
String |
Field name |
|
description |
No |
String |
Field description |
|
id |
No |
Long |
ID |
|
actived |
No |
Boolean |
Whether to display the field. The default value cannot be changed. |
|
required |
No |
Boolean |
Whether the field is mandatory |
|
searchable |
No |
Boolean |
Whether the field is searchable |
|
displayed_name |
No |
String |
Field name displayed at the frontend |
|
displayed_name_en |
No |
String |
Field name (English) displayed at the frontend |
|
create_time |
No |
String |
Creation time |
|
update_time |
No |
String |
Update time |
|
create_by |
No |
String |
Creator |
|
update_by |
No |
String |
User who updated the field |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
fd_name |
String |
Field name |
|
description |
String |
Field description |
|
id |
Long |
ID |
|
actived |
Boolean |
Whether to display the field. The default value cannot be changed. |
|
required |
Boolean |
Whether the field is mandatory |
|
searchable |
Boolean |
Whether the field is searchable |
|
displayed_name |
String |
Field name displayed at the frontend |
|
displayed_name_en |
String |
Field name (English) displayed at the frontend |
|
create_time |
String |
Creation time |
|
update_time |
String |
Update time |
|
create_by |
String |
Creator |
|
update_by |
String |
User who updated the field |
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
{
"fd_name" : "dataType",
"description" : "Data type",
"id" : "793889740775657472",
"actived" : true,
"required" : true,
"searchable" : true,
"displayed_name" : "Data type",
"displayed_name_en" : "Data type"
}
Example Responses
Status code: 200
Success
{
"data" : {
"value" : [ {
"xxx" : "StandElementFieldVO"
} ]
}
}
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.
