更新项目字段配置
功能介绍
更新项目字段配置
调用方法
请参见如何调用API。
URI
PUT /GT3KServer/v4/projects/{project_id}/field-configs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
uri |
否 |
String |
字段配置URI标识 |
|
description |
否 |
String |
描述 |
|
table_field_name |
否 |
String |
字段名称 |
|
value_type |
否 |
String |
字段类型(单行文本text、多行文本textArea、单选框radio、多选框checkbox、日期date、数字number、用户user)。 |
|
is_display |
否 |
Integer |
是否显示 |
|
is_required |
否 |
Integer |
是否必填 |
|
sort_numb |
否 |
Integer |
顺序数值 |
|
default_value |
否 |
String |
默认值 |
|
custom_field_uri |
否 |
String |
扩展字段uri(用于连表查扩展字段) |
|
resource_type |
否 |
String |
资源类型 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
参数解释: 本次请求的处理状态 取值范围: success|error |
|
result |
ResultValueString object |
参数解释: 请求结果 取值范围: 非必返 |
|
error |
ApiError object |
参数解释: 错误信息 取值范围: 非必返 |
|
request_id |
String |
参数解释: 请求的唯一id 取值范围: 非必返 |
|
address |
String |
参数解释: 本次请求的受理的服务地址。 取值范围: 非必返 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
请求示例
put https://{endpoint}/GT3KServer/v4/projects/f3087a82b44744c29a1bd69ab6ada154/field-configs
{
"uri" : "v92s10cmov8ek1jd",
"table_field_name" : "name",
"value_type" : "text"
}
响应示例
状态码：200
更新项目字段配置返回体
{
"status" : "success",
"result" : {
"value" : "success"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
更新项目字段配置返回体 |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
