更新项目字段配置顺序
功能介绍
更新项目字段配置顺序
调用方法
请参见如何调用API。
URI
PUT /v4/projects/{project_id}/field-configs/sort
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_field_config_infos |
否 |
Array of ProjectFieldConfigInfo objects |
项目字段配置入参info数组 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
由接口调用方传入,建议使用UUID保证请求的唯一性。 |
|
server_address |
String |
本次请求的受理的服务地址 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 |
|
value |
String |
实际的数据类型:单个对象,集合 或 NULL |
|
reason |
String |
业务失败的提示内容 |
|
page_size |
Integer |
分页大小 |
|
page_no |
Integer |
分页编码 |
|
has_more |
Boolean |
是否有更多 |
状态码: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}/v4/projects/{project_id}/field-configs/sort
{
"project_field_config_infos" : [ {
"uri" : "005t3o8pmtm",
"description" : "描述",
"table_field_name" : "状态、名称、编号",
"value_type" : "text",
"is_display" : 1,
"is_required" : 1,
"sort_numb" : 10,
"default_value" : "默认值",
"custom_field_uri" : "fdsj58mnfgb524",
"resource_type" : "TestCase"
} ]
}
响应示例
状态码:200
OK
{
"status" : "string",
"result" : "ok",
"error" : { },
"request_id" : "string",
"server_address" : "string"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。