# 更新项目字段配置包含更新字段选项 - RefreshProjectFieldConfig #### 功能介绍 此接口用于更新用例字段 "类型"字段时调用.同页面 设置 -\> 测试设置 -\> 用例字段设置 -\> 修改类型字段 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。 #### URI POST /v4/projects/{project_id}/field-configs/refresh 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | uri | 是 | String | 字段配置URI标识 | | description | 否 | String | 描述 | | table_field_name | 否 | String | 字段名称 | | value_type | 否 | String | 字段类型(单行文本text、多行文本textArea、单选框radio、多选框checkbox、日期date、数字number、用户user)。 | | is_display | 否 | Integer | 是否显示，0：不显示 1：显示（当is_required为1时，is_display必须传1，不可为空） | | is_required | 是 | Integer | 是否必填,0:非必填 1：必填 | | sort_numb | 否 | Integer | 顺序数值 | | default_value | 否 | String | 默认值 | | custom_field_uri | 否 | String | 扩展字段uri(用于连表查扩展字段) | | resource_type | 否 | String | **参数解释**: 资源类型 **取值范围**: - TestCase，用例。 - Task，任务。 - TestVersion，分支。 - IteratorTestCase，迭代用例。 | | project_field_config_option_infos | 否 | Array of [ProjectFieldConfigOptionInfo] objects | 项目字段配置选项入参info数组 | | delete_project_field_config_option_infos | 否 | Array of [ProjectFieldConfigOptionInfo] objects | 删除项目字段配置选项 | 表3ProjectFieldConfigOptionInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | uri | 否 | String | 字段选项URI标识.新增不传，修改、删除使用必传 | | name | 否 | String | 可选项名称 | | description | 否 | String | 描述 | | project_field_config_uri | 否 | String | 字段配置URI标识 | | sort_numb | 否 | Integer | 顺序数值 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释**: 调用此接口的响应状态。 **取值范围**: - success，表示接口调用成功。 - error，表示接口调用失败。 | | result | [ResultValueString] object | 请求返回的数据 | | error | [ApiError] object | 错误信息 | | request_id | String | 由接口调用方传入，建议使用UUID保证请求的唯一性。 | | server_address | String | 本次请求的受理的服务地址 | 表5ResultValueString | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 | | value | String | 实际的数据类型：单个对象，集合 或 NULL | | reason | String | 业务失败的提示内容 | | page_size | Integer | 分页大小 | | page_no | Integer | 分页编码 | | has_more | Boolean | 是否有更多 | 表6ApiError | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | 业务失败的错误编码 | | reason | String | 业务失败的提示内容 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释** : 业务失败的错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释** : 业务失败的提示内容 **取值范围**: 不涉及 | **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释** : 业务失败的错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释** : 业务失败的提示内容 **取值范围**: 不涉及 | **状态码：404** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释** : 业务失败的错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释** : 业务失败的提示内容 **取值范围**: 不涉及 | **状态码：500** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释** : 业务失败的错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释** : 业务失败的提示内容 **取值范围**: 不涉及 | #### 请求示例 ``` post https://{endpoint}/v4/projects/f3087a82b44744c29a1bd69ab6ada154/field-configs/refresh { "uri" : "v90200010s1gvf40", "description" : "新描述", "is_required" : 0 } ``` #### 响应示例 **状态码：200** OK ``` { "result" : { "value" : "success" } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 404 | Not Found | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-testman/ErrorCode.html)。