更新项目字段配置包含更新字段选项 - RefreshTemplateFieldConfig
功能介绍
此接口用于更新项目字段配置包含更新字段选项
调用方法
请参见如何调用API。
URI
POST /v4/{domain_id}/project/templates/{template_uri}/field-configs/refresh
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| domain_id | 是 | String | 参数解释 租户ID 取值范围 字符串 |
| template_uri | 是 | String | 参数解释 租户模板URI 取值范围 字符串 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| uri | 否 | String | 字段配置URI |
| table_field_name | 否 | String | 字段名称 |
| value_type | 否 | String | 字段类型 |
| is_display | 否 | Integer | 是否显示 |
| is_required | 否 | Integer | 是否必填 |
| is_lock | 否 | Integer | 是否锁定 |
| sort_numb | 否 | Integer | 排序编号 |
| default_value | 否 | String | 默认值 |
| custom_field_uri | 否 | String | 扩展字段URI |
| resource_type | 否 | String | 资源类型 |
| description | 否 | String | 描述 |
| project_field_config_option_infos | 否 | Array of ProjectFieldConfigOptionInfo objects | 项目字段配置选项入参info数组 |
| delete_project_field_config_option_infos | 否 | Array of ProjectFieldConfigOptionInfo objects | 删除项目字段配置选项 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 起始记录数 大于 实际总条数时，值为0，分页请求才有此值 |
| value | String | 实际的数据类型：单个对象，集合 或 NULL |
| reason | String | 业务失败的提示内容 |
| page_size | Integer | 分页大小 |
| page_no | Integer | 分页编码 |
| has_more | Boolean | 是否有更多 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释 接口调用失败错误码 取值范围 不涉及 |
| error_msg | String | 参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码：500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释 接口调用失败错误码 取值范围 不涉及 |
| error_msg | String | 参数解释 接口调用失败错误信息 取值范围 不涉及 |
请求示例
更新项目字段配置包含更新字段选项
POST https://{endpoint}/v4/{domain_id}/project/templates/{template_uri}/field-configs/refresh
{
"domain_id" : "domain-uuid-001",
"template_uri" : "template-001",
"table_field_name" : "status",
"value_type" : "radio",
"field_options" : [ "进行中", "已完成", "已取消" ]
} 响应示例
状态码：200
OK
{
"total" : 1,
"value" : "success",
"reason" : "",
"page_size" : 20,
"page_no" : 1,
"has_more" : false
} 状态码：400
Bad Request
{
"error_code" : "CLOUDTEST.00000001",
"error_msg" : "返回的错误信息"
} 状态码：500
Internal Server Error
{
"error_code" : "CLOUDTEST.00000001",
"error_msg" : "返回的错误信息"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 500 | Internal Server Error |
错误码
请参见错误码。
