修改自定义项
功能介绍
修改自定义项（包括表自定义项、属性自定义项、主题自定义项、业务指标自定义项）。
调用方法
请参见如何调用API。
URI
PUT /v2/{project_id}/design/customized-fields
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方法请参见项目ID和账号ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 使用Token认证时必选。 |
|
workspace |
是 |
String |
工作空间ID，获取方法请参见实例ID和工作空间ID。 |
|
X-Project-Id |
否 |
String |
项目ID，获取方法请参见项目ID和账号ID。 多project场景采用AK/SK认证的接口请求，则该字段必选。 |
|
Content-Type |
否 |
String |
默认值：application/json;charset=UTF-8 可选，有Body体的情况下必选，没有Body体则无需填写和校验。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
是 |
String |
自定义项类型。 枚举值：
|
|
fields |
否 |
Array of CustomizedFieldsVO objects |
自定义项列表。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
否 |
String |
编码，填写String类型替代Long类型。 |
|
name_ch |
是 |
String |
自定义项中文名称。 |
|
name_en |
是 |
String |
自定义项英文名称。 |
|
not_null |
是 |
Boolean |
是否必填。 |
|
optional_values |
否 |
String |
可选值。当可选值有多个时，用分号分隔。 |
|
type |
是 |
String |
自定义项类型。 枚举值：
|
|
ordinal |
否 |
Integer |
系统排序字段，新建、修改时不需要填写。 |
|
description |
否 |
String |
自定义项描述。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
data object |
data，统一的返回结果的最外层数据结构。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
编码，填写String类型替代Long类型。 |
|
name_ch |
String |
自定义项中文名称。 |
|
name_en |
String |
自定义项英文名称。 |
|
not_null |
Boolean |
是否必填。 |
|
optional_values |
String |
可选值。当可选值有多个时，用分号分隔。 |
|
type |
String |
自定义项类型。 枚举值：
|
|
ordinal |
Integer |
系统排序字段，新建、修改时不需要填写。 |
|
description |
String |
自定义项描述。 |
|
create_by |
String |
创建人，只读。 |
|
update_by |
String |
更新人，只读。 |
|
create_time |
String |
创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 |
|
update_time |
String |
更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，如DS.6000，请求处理失败。 |
|
error_msg |
String |
错误信息。 |
|
data |
Object |
返回的数据信息。 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，如DS.6000，请求处理失败。 |
|
error_msg |
String |
错误信息。 |
|
data |
Object |
返回的数据信息。 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，如DS.6000，请求处理失败。 |
|
error_msg |
String |
错误信息。 |
|
data |
Object |
返回的数据信息。 |
请求示例
修改表的自定义项。
PUT https://{endpoint}/v2/{project_id}/design/customized-fields
{
"type" : "TABLE",
"fields" : [ {
"id" : "1211611269321355264",
"name_ch" : "自定义项1",
"name_en" : "selfDefine1",
"not_null" : false,
"optional_values" : "",
"description" : "测试1",
"ordinal" : 0,
"type" : "TABLE"
}, {
"id" : "1211611269321355265",
"name_ch" : "自定义项2",
"name_en" : "selfDefine2",
"not_null" : true,
"optional_values" : "",
"description" : "修改2",
"ordinal" : 1,
"type" : "TABLE"
} ]
}
响应示例
状态码： 200
Success
{
"data" : {
"value" : [ {
"id" : "1211611269321355264",
"name_ch" : "自定义项1",
"name_en" : "selfDefine1",
"not_null" : false,
"optional_values" : "",
"type" : "TABLE",
"ordinal" : 0,
"description" : "测试1",
"create_by" : null,
"update_by" : null,
"create_time" : null,
"update_time" : null
}, {
"id" : "1211611269321355265",
"name_ch" : "自定义项2",
"name_en" : "selfDefine2",
"not_null" : true,
"optional_values" : "",
"type" : "TABLE",
"ordinal" : 1,
"description" : "修改2",
"create_by" : null,
"update_by" : null,
"create_time" : null,
"update_time" : null
} ]
}
}
状态码： 400
{
"error_code" : "DS.60xx",
"error_msg" : "The user request is illegal."
}
状态码： 401
{
"error_code" : "DS.60xx",
"error_msg" : "User authentication failed."
}
状态码： 403
{
"error_code" : "DS.60xx",
"error_msg" : "The user does not have permission to call this API."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Success |
|
400 |
BadRequest |
|
401 |
Unauthorized |
|
403 |
Forbidden |
